diff --git a/sdk/communication/azure-communication-messages/_meta.json b/sdk/communication/azure-communication-messages/_meta.json new file mode 100644 index 0000000000000..bcf846b6f796e --- /dev/null +++ b/sdk/communication/azure-communication-messages/_meta.json @@ -0,0 +1,7 @@ +{ + "commit": "228acac22c34fa19cd629ba2df005822ab8ba959", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/communication/Communication.Messages", + "@azure-tools/typespec-python": "0.24.3", + "@autorest/python": "6.14.3" +} \ No newline at end of file diff --git a/sdk/communication/azure-communication-messages/azure/__init__.py b/sdk/communication/azure-communication-messages/azure/__init__.py index 0d1f7edf5dc63..d55ccad1f573f 100644 --- a/sdk/communication/azure-communication-messages/azure/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/__init__.py @@ -1 +1 @@ -__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-messages/azure/communication/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/__init__.py index 0d1f7edf5dc63..d55ccad1f573f 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/__init__.py @@ -1 +1 @@ -__path__ = __import__('pkgutil').extend_path(__path__, __name__) # type: ignore +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py index 12815161d8d61..3ce4f906d3dfd 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/__init__.py @@ -18,9 +18,10 @@ except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk + __all__ = [ - 'NotificationMessagesClient', - 'MessageTemplateClient', + "NotificationMessagesClient", + "MessageTemplateClient", ] __all__.extend([p for p in _patch_all if p not in __all__]) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py deleted file mode 100644 index 97f1f0cc40958..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_api_versions.py +++ /dev/null @@ -1,15 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from enum import Enum -from azure.core import CaseInsensitiveEnumMeta - - -class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta): - V2023_08_24_PREVIEW = "2023-08-24-preview" - V2024_02_01 = "2024-02-01" - - -DEFAULT_VERSION = ApiVersion.V2024_02_01.value diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py index 6007feaa0ca97..3380a5d2f966d 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, TYPE_CHECKING, Union +from typing_extensions import Self from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential @@ -22,13 +23,16 @@ # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class NotificationMessagesClient(NotificationMessagesClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + +class NotificationMessagesClient( + NotificationMessagesClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword """NotificationMessagesClient. :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -37,38 +41,33 @@ class NotificationMessagesClient(NotificationMessagesClientOperationsMixin): # :paramtype api_version: str """ - def __init__( - self, - endpoint: str, - credential: Union["TokenCredential", AzureKeyCredential], - **kwargs: Any - ) -> None: - _endpoint = '{endpoint}' + def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None: + _endpoint = "{endpoint}" self._config = NotificationMessagesClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - _policies = kwargs.pop('policies', None) + _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] + _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: + 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 @@ -88,7 +87,7 @@ def send_request( 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) @@ -97,19 +96,21 @@ def send_request( def close(self) -> None: self._client.close() - def __enter__(self) -> "NotificationMessagesClient": + def __enter__(self) -> Self: self._client.__enter__() return self def __exit__(self, *exc_details: Any) -> None: self._client.__exit__(*exc_details) + + class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword """MessageTemplateClient. :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -118,35 +119,33 @@ class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: di :paramtype api_version: str """ - def __init__( - self, - endpoint: str, - credential: Union["TokenCredential", AzureKeyCredential], - **kwargs: Any - ) -> None: - _endpoint = '{endpoint}' + def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None: + _endpoint = "{endpoint}" self._config = MessageTemplateClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - _policies = kwargs.pop('policies', None) + _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] + _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: + 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 @@ -166,7 +165,7 @@ def send_request( 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) @@ -175,7 +174,7 @@ def send_request( def close(self) -> None: self._client.close() - def __enter__(self) -> "MessageTemplateClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py index c2a1df548b8b6..b47359e3a0b53 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_configuration.py @@ -18,7 +18,7 @@ from azure.core.credentials import TokenCredential -class NotificationMessagesClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class NotificationMessagesClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for NotificationMessagesClient. Note that all parameters used to create this instance are saved as instance @@ -27,7 +27,7 @@ class NotificationMessagesClientConfiguration: # pylint: disable=too-many-ins :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -36,13 +36,8 @@ class NotificationMessagesClientConfiguration: # pylint: disable=too-many-ins :paramtype api_version: str """ - def __init__( - self, - endpoint: str, - credential: Union["TokenCredential", AzureKeyCredential], - **kwargs: Any - ) -> None: - api_version: str = kwargs.pop('api_version', "2024-02-01") + def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-01") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -52,34 +47,33 @@ def __init__( self.endpoint = endpoint self.credential = credential self.api_version = api_version - self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) - kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.credential_scopes = kwargs.pop("credential_scopes", ["https://communication.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "communication-messages/{}".format(VERSION)) self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _infer_policy(self, **kwargs): - if hasattr(self.credential, 'get_token'): + if hasattr(self.credential, "get_token"): return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) if isinstance(self.credential, AzureKeyCredential): return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **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') + 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) -class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + + +class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for MessageTemplateClient. Note that all parameters used to create this instance are saved as instance @@ -88,7 +82,7 @@ class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials.TokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -97,13 +91,8 @@ class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance :paramtype api_version: str """ - def __init__( - self, - endpoint: str, - credential: Union["TokenCredential", AzureKeyCredential], - **kwargs: Any - ) -> None: - api_version: str = kwargs.pop('api_version', "2024-02-01") + def __init__(self, endpoint: str, credential: Union["TokenCredential", AzureKeyCredential], **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2024-02-01") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -113,30 +102,27 @@ def __init__( self.endpoint = endpoint self.credential = credential self.api_version = api_version - self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) - kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.credential_scopes = kwargs.pop("credential_scopes", ["https://communication.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "communication-messages/{}".format(VERSION)) self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _infer_policy(self, **kwargs): - if hasattr(self.credential, 'get_token'): + if hasattr(self.credential, "get_token"): return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) if isinstance(self.credential, AzureKeyCredential): return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **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') + 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/communication/azure-communication-messages/azure/communication/messages/_model_base.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py index ebf9c5fcb0dd2..43fd8c7e9b1b4 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_model_base.py @@ -6,6 +6,7 @@ # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except +import copy import calendar import decimal import functools @@ -13,7 +14,6 @@ import logging import base64 import re -import copy import typing import enum import email.utils @@ -324,17 +324,9 @@ def _get_type_alias_type(module_name: str, alias_name: str): 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) - } + 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) - }) + 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: @@ -347,7 +339,7 @@ def _get_model(module_name: str, model_name: str): 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) + self._data = data def __contains__(self, key: typing.Any) -> bool: return key in self._data @@ -386,16 +378,13 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: return default @typing.overload - def pop(self, key: str) -> typing.Any: - ... + def pop(self, key: str) -> typing.Any: ... @typing.overload - def pop(self, key: str, default: _T) -> _T: - ... + 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) -> typing.Any: ... def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: if default is _UNSET: @@ -412,12 +401,10 @@ 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: - ... + 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) -> typing.Any: ... def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: if default is _UNSET: @@ -550,7 +537,9 @@ def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: @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 + 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 @@ -581,8 +570,9 @@ def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing. 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 + 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) @@ -593,18 +583,70 @@ 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 - ) + 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 {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 _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +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) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + 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()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 annotation: typing.Any, module: typing.Optional[str], @@ -632,11 +674,6 @@ def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, 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 @@ -651,36 +688,27 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj # 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) + if len(annotation.__args__) <= 2: # 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 + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) except AttributeError: pass + # is it union? 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 - ) + for arg in _sorted_annotations(annotation.__args__) # 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: @@ -689,20 +717,10 @@ def _deserialize_with_union(deserializers, obj): 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, + module, ) except (AttributeError, IndexError): pass @@ -710,35 +728,16 @@ def _deserialize_dict( 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 + for dt in annotation.__args__ # pyright: ignore ] - return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) 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) + return functools.partial(_deserialize_sequence, deserializer, module) except (TypeError, IndexError, AttributeError, SyntaxError): pass @@ -876,11 +875,14 @@ def rest_field( visibility=visibility, default=default, format=format, - is_multipart_file_input=is_multipart_file_input) + 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 + visibility: typing.Optional[typing.List[str]] = None, ) -> typing.Any: - return _RestField(name=name, type=type, is_discriminator=True) + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py index b610e644f4c28..5a3a47e6ff3a5 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/__init__.py @@ -12,9 +12,10 @@ from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk + __all__ = [ - 'NotificationMessagesClientOperationsMixin', - 'MessageTemplateClientOperationsMixin', + "NotificationMessagesClientOperationsMixin", + "MessageTemplateClientOperationsMixin", ] __all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py index e6cf4c1670a6f..4c556c4aa0a38 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_operations/_operations.py @@ -10,16 +10,18 @@ from io import IOBase import json import sys -from typing import Any, Callable, Dict, IO, Iterable, Iterator, List, Optional, TypeVar, Union, overload +from typing import Any, Callable, Dict, IO, Iterable, Iterator, List, Optional, Type, TypeVar, Union, overload import urllib.parse import uuid -from azure.core.exceptions import (ClientAuthenticationError, - HttpResponseError, - ResourceExistsError, - ResourceNotFoundError, - ResourceNotModifiedError, - map_error) +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 @@ -35,134 +37,105 @@ 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') +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_notification_messages_send_request( - **kwargs: Any -) -> HttpRequest: +def build_notification_messages_send_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', "2024-02-01")) - accept = _headers.pop('Accept', "application/json") + 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-01")) + accept = _headers.pop("Accept", "application/json") # Construct URL _url = "/messages/notifications:send" # Construct parameters - _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _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') + datetime.datetime.now(datetime.timezone.utc), "rfc-1123" + ) if content_type is not None: - _headers['Content-Type'] = _SERIALIZER.header("content_type", content_type, 'str') + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest( - method="POST", - url=_url, - params=_params, - headers=_headers, - **kwargs - ) + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) def build_notification_messages_download_media_request( # pylint: disable=name-too-long - id: str, - **kwargs: Any + 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', "2024-02-01")) - accept = _headers.pop('Accept', "application/octet-stream") + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-01")) + accept = _headers.pop("Accept", "application/octet-stream") # Construct URL _url = "/messages/streams/{id}" path_format_arguments = { - "id": _SERIALIZER.url("id", id, 'str'), + "id": _SERIALIZER.url("id", id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters - _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers - _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest( - method="GET", - url=_url, - params=_params, - headers=_headers, - **kwargs - ) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) def build_message_template_list_templates_request( # pylint: disable=name-too-long - channel_id: str, - *, - maxpagesize: Optional[int] = None, - **kwargs: Any + channel_id: str, *, 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', "2024-02-01")) - accept = _headers.pop('Accept', "application/json") + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-02-01")) + accept = _headers.pop("Accept", "application/json") # Construct URL _url = "/messages/channels/{channelId}/templates" path_format_arguments = { - "channelId": _SERIALIZER.url("channel_id", channel_id, 'str'), + "channelId": _SERIALIZER.url("channel_id", channel_id, "str"), } _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters - _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") if maxpagesize is not None: - _params['maxpagesize'] = _SERIALIZER.query("maxpagesize", maxpagesize, 'int') + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") # Construct headers - _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest( - method="GET", - url=_url, - params=_params, - headers=_headers, - **kwargs - ) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -class NotificationMessagesClientOperationsMixin( # pylint: disable=name-too-long - NotificationMessagesClientMixinABC -): + +class NotificationMessagesClientOperationsMixin(NotificationMessagesClientMixinABC): # pylint: disable=name-too-long @overload def send( - self, - body: _models.NotificationContent, - *, - content_type: str = "application/json", - **kwargs: Any + self, body: _models.NotificationContent, *, content_type: str = "application/json", **kwargs: Any ) -> _models.SendMessageResult: - # pylint: disable=line-too-long """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: ~azure.communication.messages.models.NotificationContent :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -179,36 +152,29 @@ def send( # JSON input template for discriminator value "image": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "image", - "mediaUri": "str", # A media url for the file. Required if the type is one - of the supported media types, e.g. image. Required. + "mediaUri": "str", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ], - "content": "str" # Optional. Optional text content. + "content": "str" } # JSON input template for discriminator value "template": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "template", "template": { - "language": "str", # The template's language, in the ISO 639 format, - consist of a two-letter language code followed by an optional two-letter - country code, e.g., 'en' or 'en_US'. Required. - "name": "str", # Name of the template. Required. + "language": "str", + "name": "str", "bindings": message_template_bindings, "values": [ message_template_value ] }, "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -217,41 +183,34 @@ def send( "kind": "whatsApp", "body": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "buttons": [ { - "refValue": "str", # The name of the referenced item in the - template values. Required. - "subType": "str" # The WhatsApp button sub type. Required. - Known values are: "quickReply" and "url". + "refValue": "str", + "subType": "str" } ], "footer": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "header": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ] } # JSON input template for discriminator value "text": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. - "content": "str", # Message content. Required. + "channelRegistrationId": "str", + "content": "str", "kind": "text", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -262,25 +221,18 @@ def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } """ @overload - def send( - self, - body: JSON, - *, - content_type: str = "application/json", - **kwargs: Any - ) -> _models.SendMessageResult: + def send(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.SendMessageResult: """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -296,9 +248,8 @@ def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } @@ -306,15 +257,11 @@ def send( @overload def send( - self, - body: IO[bytes], - *, - content_type: str = "application/json", - **kwargs: Any + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.SendMessageResult: """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -330,25 +277,21 @@ def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } """ - @distributed_trace def send( - self, - body: Union[_models.NotificationContent, JSON, IO[bytes]], - **kwargs: Any + self, body: Union[_models.NotificationContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.SendMessageResult: - # pylint: disable=line-too-long """Sends a notification message from Business to User. - :param body: Is one of the following types: NotificationContent, JSON, IO[bytes] Required. + :param body: Body parameter. Is one of the following types: NotificationContent, JSON, + IO[bytes] Required. :type body: ~azure.communication.messages.models.NotificationContent or JSON or IO[bytes] :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping :rtype: ~azure.communication.messages.models.SendMessageResult @@ -362,36 +305,29 @@ def send( # JSON input template for discriminator value "image": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "image", - "mediaUri": "str", # A media url for the file. Required if the type is one - of the supported media types, e.g. image. Required. + "mediaUri": "str", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ], - "content": "str" # Optional. Optional text content. + "content": "str" } # JSON input template for discriminator value "template": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "template", "template": { - "language": "str", # The template's language, in the ISO 639 format, - consist of a two-letter language code followed by an optional two-letter - country code, e.g., 'en' or 'en_US'. Required. - "name": "str", # Name of the template. Required. + "language": "str", + "name": "str", "bindings": message_template_bindings, "values": [ message_template_value ] }, "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -400,41 +336,34 @@ def send( "kind": "whatsApp", "body": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "buttons": [ { - "refValue": "str", # The name of the referenced item in the - template values. Required. - "subType": "str" # The WhatsApp button sub type. Required. - Known values are: "quickReply" and "url". + "refValue": "str", + "subType": "str" } ], "footer": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "header": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ] } # JSON input template for discriminator value "text": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. - "content": "str", # Message content. Required. + "channelRegistrationId": "str", + "content": "str", "kind": "text", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -445,25 +374,25 @@ def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } """ - error_map = { - 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + 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.SendMessageResult] = kwargs.pop( - 'cls', None - ) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SendMessageResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -480,15 +409,13 @@ def send( params=_params, ) 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.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 + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -500,30 +427,25 @@ def send( raise HttpResponseError(response=response) response_headers = {} - response_headers['Repeatability-Result']=self._deserialize('str', response.headers.get('Repeatability-Result')) - response_headers['x-ms-client-request-id']=self._deserialize('str', response.headers.get('x-ms-client-request-id')) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize( - _models.SendMessageResult, - response.json() - ) + deserialized = _deserialize(_models.SendMessageResult, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized # type: ignore - - @distributed_trace - def download_media( - self, - id: str, - **kwargs: Any - ) -> Iterator[bytes]: + def download_media(self, id: str, **kwargs: Any) -> Iterator[bytes]: """Download the Media payload from a User to Business message. :param id: The stream ID. Required. @@ -532,20 +454,18 @@ def download_media( :rtype: Iterator[bytes] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, - 304: ResourceNotModifiedError + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + error_map.update(kwargs.pop("error_map", {}) or {}) _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[Iterator[bytes]] = kwargs.pop( - 'cls', None - ) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) _request = build_notification_messages_download_media_request( id=id, @@ -554,15 +474,13 @@ def download_media( params=_params, ) 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.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 + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response @@ -574,27 +492,22 @@ def download_media( 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-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) deserialized = response.iter_bytes() if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized # type: ignore -class MessageTemplateClientOperationsMixin( - MessageTemplateClientMixinABC -): + +class MessageTemplateClientOperationsMixin(MessageTemplateClientMixinABC): @distributed_trace - def list_templates( - self, - channel_id: str, - **kwargs: Any - ) -> Iterable["_models.MessageTemplateItem"]: - # pylint: disable=line-too-long + def list_templates(self, channel_id: str, **kwargs: Any) -> Iterable["_models.MessageTemplateItem"]: """List all templates for given Azure Communication Services channel. :param channel_id: The registration ID of the channel. Required. @@ -612,14 +525,10 @@ def list_templates( # JSON input template for discriminator value "whatsApp": message_template_item = { "kind": "whatsApp", - "language": "str", # The template's language, in the ISO 639 format, consist - of a two-letter language code followed by an optional two-letter country code, - e.g., 'en' or 'en_US'. Required. - "name": "str", # The template's name. Required. - "status": "str", # The aggregated template status. Required. Known values - are: "approved", "rejected", "pending", and "paused". - "content": {} # Optional. WhatsApp platform's template content. This is the - payload returned from WhatsApp API. + "language": "str", + "name": "str", + "status": "str", + "content": {} } # response body for status code(s): 200 @@ -629,16 +538,19 @@ def list_templates( _params = kwargs.pop("params", {}) or {} maxpagesize = kwargs.pop("maxpagesize", None) - cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop( - 'cls', None - ) + cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop("cls", None) - error_map = { - 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + error_map.update(kwargs.pop("error_map", {}) or {}) + def prepare_request(next_link=None): if not next_link: + _request = build_message_template_list_templates_request( channel_id=channel_id, maxpagesize=maxpagesize, @@ -647,19 +559,29 @@ def prepare_request(next_link=None): params=_params, ) 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.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 = 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) + _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), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -669,29 +591,22 @@ def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() list_of_elem = _deserialize(List[_models.MessageTemplateItem], deserialized["value"]) if cls: - list_of_elem = cls(list_of_elem) # type: ignore + 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 + 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 - ) + return ItemPaged(get_next, extract_data) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py index acf74720bcfd7..eb3162ba82cb9 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_patch.py @@ -6,11 +6,7 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import ( - List, - Any, - Union -) +from typing import List, Any, Union from urllib.parse import urlparse from azure.core.credentials import TokenCredential, AzureKeyCredential from ._shared.utils import parse_connection_str @@ -21,6 +17,7 @@ from ._shared.auth_policy_utils import get_authentication_policy from ._api_versions import DEFAULT_VERSION + class NotificationMessagesClient(NotificationMessagesClientGenerated): """A client to interact with the AzureCommunicationService Messaging service. @@ -52,7 +49,7 @@ def __init__(self, endpoint: str, credential: Union[TokenCredential, AzureKeyCre self._endpoint = endpoint self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) - self._authentication_policy = get_authentication_policy(endpoint, credential) + self._authentication_policy = get_authentication_policy(endpoint, credential) self._credential = credential super().__init__( self._endpoint, @@ -61,6 +58,7 @@ def __init__(self, endpoint: str, credential: Union[TokenCredential, AzureKeyCre api_version=self._api_version, **kwargs ) + @classmethod def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "NotificationMessagesClient": """Create NotificationMessagesClient from a Connection String. @@ -74,6 +72,7 @@ def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "NotificationMe endpoint, access_key = parse_connection_str(conn_str) return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + class MessageTemplateClient(MessageTemplateClientGenerated): """A client to interact with the AzureCommunicationService Messaging service. @@ -105,12 +104,14 @@ def __init__(self, endpoint: str, credential: Union[TokenCredential, AzureKeyCre self._endpoint = endpoint self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) - self._authentication_policy = get_authentication_policy(endpoint, credential) + self._authentication_policy = get_authentication_policy(endpoint, credential) self._credential = credential super().__init__( - self._endpoint, self._credential, + self._endpoint, + self._credential, authentication_policy=self._authentication_policy, - api_version=self._api_version, **kwargs + api_version=self._api_version, + **kwargs ) @classmethod @@ -126,11 +127,13 @@ def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "MessageTemplat endpoint, access_key = parse_connection_str(conn_str) return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + __all__: List[str] = [ "NotificationMessagesClient", "MessageTemplateClient", ] # Add all objects you want publicly available to users at this package level + def patch_sdk(): """Do not remove from this file. diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py index 75e26c415d2c5..8139854b97bb8 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_serialization.py @@ -144,6 +144,8 @@ def _json_attemp(data): # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -349,9 +351,7 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: def as_dict( self, keep_readonly: bool = True, - key_transformer: Callable[ - [str, Dict[str, Any], Any], Any - ] = attribute_transformer, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, **kwargs: Any ) -> JSON: """Return a dict that can be serialized using json.dump. @@ -540,7 +540,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, type]]=None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -748,7 +748,7 @@ 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] - do_quote = not kwargs.get('skip_quote', False) + 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 @@ -907,12 +907,8 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): 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 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] @@ -1369,7 +1365,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]]=None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1447,7 +1443,7 @@ def _deserialize(self, target_obj, data): elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: attributes = response._attribute_map # type: ignore diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py deleted file mode 100644 index c5172309c8319..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py +++ /dev/null @@ -1,53 +0,0 @@ -# ------------------------------------------------------------------------ -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# ------------------------------------------------------------------------- - -from typing import Union -from azure.core.credentials import TokenCredential, AzureKeyCredential -from azure.core.credentials_async import AsyncTokenCredential -from azure.core.pipeline.policies import ( - AsyncBearerTokenCredentialPolicy, - BearerTokenCredentialPolicy, -) -from .._shared.policy import HMACCredentialsPolicy - - -def get_authentication_policy( - endpoint: str, - credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str], - decode_url: bool = False, - is_async: bool = False, -): - # type: (...) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy] - """Returns the correct authentication policy based on which credential is being passed. - - :param endpoint: The endpoint to which we are authenticating to. - :type endpoint: str - :param credential: The credential we use to authenticate to the service - :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] - :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` - :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy - :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.messages.shared.policy.HMACCredentialsPolicy - """ - - if credential is None: - raise ValueError("Parameter 'credential' must not be None.") - if hasattr(credential, "get_token"): - if is_async: - return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore - ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore - if isinstance(credential, (AzureKeyCredential, str)): - return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) - - raise TypeError( - f"Unsupported credential: {format(type(credential))}. Use an access token string to use HMACCredentialsPolicy" - "or a token credential from azure.identity" - ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py deleted file mode 100644 index 7b646472045c0..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py +++ /dev/null @@ -1,402 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ -from enum import Enum -import warnings -from typing import Mapping, Optional, Union, Any, cast -from typing_extensions import Literal, TypedDict, Protocol, runtime_checkable - -from azure.core import CaseInsensitiveEnumMeta - - -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) - item = "MICROSOFT_TEAMS_APP" - return super().__getattribute__(item) - - -class CommunicationIdentifierKind(str, Enum, metaclass=DeprecatedEnumMeta): - """Communication Identifier Kind. - - For checking yet unknown identifiers it is better to rely on the presence of the `raw_id` property, - as new or existing distinct type identifiers always contain the `raw_id` property. - 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. - """ - - UNKNOWN = "unknown" - COMMUNICATION_USER = "communication_user" - PHONE_NUMBER = "phone_number" - MICROSOFT_TEAMS_USER = "microsoft_teams_user" - MICROSOFT_TEAMS_APP = "microsoft_teams_app" - - -class CommunicationCloudEnvironment(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The cloud environment that the identifier belongs to""" - - PUBLIC = "PUBLIC" - DOD = "DOD" - GCCH = "GCCH" - - -@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.""" - ... - - -PHONE_NUMBER_PREFIX = "4:" -BOT_PREFIX = "28:" -BOT_PUBLIC_CLOUD_PREFIX = "28:orgid:" -BOT_DOD_CLOUD_PREFIX = "28:dod:" -BOT_DOD_CLOUD_GLOBAL_PREFIX = "28:dod-global:" -BOT_GCCH_CLOUD_PREFIX = "28:gcch:" -BOT_GCCH_CLOUD_GLOBAL_PREFIX = "28:gcch-global:" -TEAMS_APP_PUBLIC_CLOUD_PREFIX = "28:orgid:" -TEAMS_APP_DOD_CLOUD_PREFIX = "28:dod:" -TEAMS_APP_GCCH_CLOUD_PREFIX = "28:gcch:" -TEAMS_USER_ANONYMOUS_PREFIX = "8:teamsvisitor:" -TEAMS_USER_PUBLIC_CLOUD_PREFIX = "8:orgid:" -TEAMS_USER_DOD_CLOUD_PREFIX = "8:dod:" -TEAMS_USER_GCCH_CLOUD_PREFIX = "8:gcch:" -ACS_USER_PREFIX = "8:acs:" -ACS_USER_DOD_CLOUD_PREFIX = "8:dod-acs:" -ACS_USER_GCCH_CLOUD_PREFIX = "8:gcch-acs:" -SPOOL_USER_PREFIX = "8:spool:" - - -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 - """The properties of the identifier.""" - raw_id: str - """The raw ID of the identifier.""" - - def __init__(self, id: str, **kwargs: Any) -> None: - """ - :param str id: ID of the Communication user as returned from Azure Communication Identity. - :keyword str raw_id: The raw ID of the identifier. If not specified, the 'id' value will be used. - """ - self.properties = CommunicationUserProperties(id=id) - raw_id: Optional[str] = kwargs.get("raw_id") - self.raw_id = raw_id if raw_id is not None else id - - def __eq__(self, other): - try: - if other.raw_id: - return self.raw_id == other.raw_id - return self.raw_id == other.properties["id"] - except Exception: # pylint: disable=broad-except - return False - - -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 - """The properties of the identifier.""" - raw_id: str - """The raw ID of the identifier.""" - - def __init__(self, value: str, **kwargs: Any) -> None: - """ - :param str value: The phone number. - :keyword str raw_id: The raw ID of the identifier. If not specified, this will be constructed from - the 'value' parameter. - """ - self.properties = PhoneNumberProperties(value=value) - 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) - - def __eq__(self, other): - try: - if other.raw_id: - return self.raw_id == other.raw_id - return self.raw_id == self._format_raw_id(other.properties) - except Exception: # pylint:disable=broad-except - return False - - def _format_raw_id(self, properties: PhoneNumberProperties) -> str: - # We just assume correct E.164 format here because - # validation should only happen server-side, not client-side. - value = properties["value"] - return f"{PHONE_NUMBER_PREFIX}{value}" - - -class UnknownIdentifier: - """Represents an identifier of an unknown type. - - It will be encountered in communications with endpoints that are not - identifiable by this version of the SDK. - - For checking yet unknown identifiers it is better to rely on the presence of the `raw_id` property, - as new or existing distinct type identifiers always contain the `raw_id` property. - 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] - """The properties of the identifier.""" - raw_id: str - """The raw ID of the identifier.""" - - def __init__(self, identifier: str) -> None: - """ - :param str identifier: The ID of the identifier. - """ - self.raw_id = identifier - self.properties = {} - - def __eq__(self, other): - try: - return self.raw_id == other.raw_id - except AttributeError: - return False - - -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 - """Set this to true if the user is anonymous for example when joining a meeting with a share link.""" - cloud: Union[CommunicationCloudEnvironment, str] - """Cloud environment that this identifier belongs to.""" - - -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 - """The properties of the identifier.""" - raw_id: str - """The raw ID of the identifier.""" - - def __init__(self, user_id: str, **kwargs: Any) -> None: - """ - :param str user_id: Microsoft Teams user id. - :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. - :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment - :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from - the other properties. - """ - self.properties = MicrosoftTeamsUserProperties( - user_id=user_id, - is_anonymous=kwargs.get("is_anonymous", False), - 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) - - def __eq__(self, other): - try: - if other.raw_id: - return self.raw_id == other.raw_id - return self.raw_id == self._format_raw_id(other.properties) - except Exception: # pylint: disable=broad-except - return False - - def _format_raw_id(self, properties: MicrosoftTeamsUserProperties) -> str: - user_id = properties["user_id"] - if properties["is_anonymous"]: - return f"{TEAMS_USER_ANONYMOUS_PREFIX}{user_id}" - cloud = properties["cloud"] - if cloud == CommunicationCloudEnvironment.DOD: - return f"{TEAMS_USER_DOD_CLOUD_PREFIX}{user_id}" - if cloud == CommunicationCloudEnvironment.GCCH: - return f"{TEAMS_USER_GCCH_CLOUD_PREFIX}{user_id}" - if cloud == CommunicationCloudEnvironment.PUBLIC: - return f"{TEAMS_USER_PUBLIC_CLOUD_PREFIX}{user_id}" - return f"{TEAMS_USER_PUBLIC_CLOUD_PREFIX}{user_id}" - - -class MicrosoftTeamsAppProperties(TypedDict): - """Dictionary of properties for a MicrosoftTeamsAppIdentifier.""" - app_id: str - """The id of the Microsoft Teams application.""" - cloud: Union[CommunicationCloudEnvironment, str] - """Cloud environment that this identifier belongs to.""" - - -class _botbackcompatdict(dict): - """Backwards compatible properties.""" - def __getitem__(self, __key: Any) -> Any: - try: - return super().__getitem__(__key) - except KeyError: - if __key == "bot_id": - return super().__getitem__("app_id") - if __key == "is_resource_account_configured": - return True - raise - - -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 - """The properties of the identifier.""" - raw_id: str - """The raw ID of the identifier.""" - - def __init__(self, app_id: str, **kwargs: Any) -> None: - """ - :param str app_id: Microsoft Teams application id. - :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment - :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, - )) - 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) - - def __eq__(self, other): - try: - if other.raw_id: - return self.raw_id == other.raw_id - return self.raw_id == self._format_raw_id(other.properties) - except Exception: # pylint: disable=broad-except - return False - - def _format_raw_id(self, properties: MicrosoftTeamsAppProperties) -> str: - app_id = properties["app_id"] - cloud = properties["cloud"] - if cloud == CommunicationCloudEnvironment.DOD: - return f"{TEAMS_APP_DOD_CLOUD_PREFIX}{app_id}" - if cloud == CommunicationCloudEnvironment.GCCH: - return f"{TEAMS_APP_GCCH_CLOUD_PREFIX}{app_id}" - return f"{TEAMS_APP_PUBLIC_CLOUD_PREFIX}{app_id}" - - -class _MicrosoftBotIdentifier(MicrosoftTeamsAppIdentifier): - """Represents an identifier for a Microsoft bot. - - DEPRECATED. Only used in cases of backwards compatibility. - """ - - def __init__(self, bot_id, **kwargs): - """ - :param str bot_id: Microsoft bot id. - :keyword bool is_resource_account_configured: `False` if the identifier is global. - Default value is `True` for tennantzed bots. - :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment - """ - warnings.warn( - "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", - DeprecationWarning - ) - super().__init__(bot_id, **kwargs) - - -def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements - """ - Creates a CommunicationIdentifier from a given raw ID. - - When storing raw IDs use this function to restore the identifier that was encoded in the raw ID. - - :param str raw_id: A raw ID to construct the CommunicationIdentifier from. - :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier - """ - if raw_id.startswith(PHONE_NUMBER_PREFIX): - return PhoneNumberIdentifier( - value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id - ) - - segments = raw_id.split(":", maxsplit=2) - if len(segments) < 3: - return UnknownIdentifier(identifier=raw_id) - - 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 - ) - if prefix == TEAMS_USER_PUBLIC_CLOUD_PREFIX: - return MicrosoftTeamsUserIdentifier( - user_id=suffix, - is_anonymous=False, - cloud=CommunicationCloudEnvironment.PUBLIC, - raw_id=raw_id, - ) - if prefix == TEAMS_USER_DOD_CLOUD_PREFIX: - return MicrosoftTeamsUserIdentifier( - user_id=suffix, - is_anonymous=False, - cloud=CommunicationCloudEnvironment.DOD, - raw_id=raw_id, - ) - if prefix == TEAMS_USER_GCCH_CLOUD_PREFIX: - return MicrosoftTeamsUserIdentifier( - user_id=suffix, - is_anonymous=False, - cloud=CommunicationCloudEnvironment.GCCH, - raw_id=raw_id, - ) - if prefix == TEAMS_APP_PUBLIC_CLOUD_PREFIX: - return MicrosoftTeamsAppIdentifier( - app_id=suffix, - cloud=CommunicationCloudEnvironment.PUBLIC, - raw_id=raw_id, - ) - if prefix == TEAMS_APP_DOD_CLOUD_PREFIX: - return MicrosoftTeamsAppIdentifier( - app_id=suffix, - cloud=CommunicationCloudEnvironment.DOD, - raw_id=raw_id, - ) - if prefix == TEAMS_APP_GCCH_CLOUD_PREFIX: - return MicrosoftTeamsAppIdentifier( - app_id=suffix, - cloud=CommunicationCloudEnvironment.GCCH, - raw_id=raw_id, - ) - if prefix in [ - ACS_USER_PREFIX, - ACS_USER_DOD_CLOUD_PREFIX, - ACS_USER_GCCH_CLOUD_PREFIX, - SPOOL_USER_PREFIX, - ]: - return CommunicationUserIdentifier(id=raw_id, raw_id=raw_id) - return UnknownIdentifier(identifier=raw_id) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py deleted file mode 100644 index 79aa48136fd35..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py +++ /dev/null @@ -1,121 +0,0 @@ -# ------------------------------------------------------------------------ -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# ------------------------------------------------------------------------- - -import hashlib -import urllib -import base64 -import hmac -from urllib.parse import ParseResult, urlparse -from typing import Union -from azure.core.credentials import AzureKeyCredential -from azure.core.pipeline.policies import SansIOHTTPPolicy -from .utils import get_current_utc_time - - -class HMACCredentialsPolicy(SansIOHTTPPolicy): - """Implementation of HMAC authentication policy. - - :param str host: The host of the endpoint url for Azure Communication Service resource - :param access_key: The access key we use to authenticate to the service - :type access_key: str or AzureKeyCredential - :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` - """ - - def __init__( - self, - host, # type: str - access_key, # type: Union[str, AzureKeyCredential] - decode_url=False, # type: bool - ): - # type: (...) -> None - super(HMACCredentialsPolicy, self).__init__() - - if host.startswith("https://"): - self._host = host.replace("https://", "") - - if host.startswith("http://"): - self._host = host.replace("http://", "") - - self._access_key = access_key - self._decode_url = decode_url - - def _compute_hmac( - self, value # type: str - ): - if isinstance(self._access_key, AzureKeyCredential): - decoded_secret = base64.b64decode(self._access_key.key) - else: - decoded_secret = base64.b64decode(self._access_key) - - digest = hmac.new(decoded_secret, value.encode("utf-8"), hashlib.sha256).digest() - - return base64.b64encode(digest).decode("utf-8") - - def _sign_request(self, request): - verb = request.http_request.method.upper() - - # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) - query_url = parsed_url.path - - if parsed_url.query: - query_url += "?" + parsed_url.query - - # Need URL() to get a correct encoded key value, from "%3A" to ":", when transport is in type AioHttpTransport. - # There's a similar scenario in azure-storage-blob and azure-appconfiguration, the check logic is from there. - try: - from yarl import URL - from azure.core.pipeline.transport import ( # pylint:disable=non-abstract-transport-import - AioHttpTransport, - ) - - if ( - isinstance(request.context.transport, AioHttpTransport) - or isinstance( - getattr(request.context.transport, "_transport", None), - AioHttpTransport, - ) - or isinstance( - getattr( - getattr(request.context.transport, "_transport", None), - "_transport", - None, - ), - AioHttpTransport, - ) - ): - query_url = str(URL(query_url)) - except (ImportError, TypeError): - pass - - if self._decode_url: - query_url = urllib.parse.unquote(query_url) - - signed_headers = "x-ms-date;host;x-ms-content-sha256" - - utc_now = get_current_utc_time() - if request.http_request.body is None: - request.http_request.body = "" - content_digest = hashlib.sha256((request.http_request.body.encode("utf-8"))).digest() - content_hash = base64.b64encode(content_digest).decode("utf-8") - - string_to_sign = verb + "\n" + query_url + "\n" + utc_now + ";" + self._host + ";" + content_hash - - signature = self._compute_hmac(string_to_sign) - - signature_header = { - "x-ms-date": utc_now, - "x-ms-content-sha256": content_hash, - "x-ms-return-client-request-id": "true", - "Authorization": "HMAC-SHA256 SignedHeaders=" + signed_headers + "&Signature=" + signature, - } - - request.http_request.headers.update(signature_header) - - return request - - def on_request(self, request): - self._sign_request(request) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py deleted file mode 100644 index 54603e7b32ced..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py +++ /dev/null @@ -1,143 +0,0 @@ -# ------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- - -from threading import Lock, Condition, Timer, TIMEOUT_MAX, Event -from datetime import timedelta -from typing import Any - -from .utils import get_current_utc_as_int -from .utils import create_access_token - - -class CommunicationTokenCredential(object): - """Credential type used for authenticating to an Azure Communication service. - :param str token: The token used to authenticate to an Azure Communication service. - :keyword token_refresher: The sync token refresher to provide capacity to fetch a fresh token. - The returned token must be valid (expiration date must be in the future). - :paramtype token_refresher: Callable[[], AccessToken] - :keyword bool proactive_refresh: Whether to refresh the token proactively or not. - If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use - a background thread to attempt to refresh the token within 10 minutes before the cached token expires, - the proactive refresh will request a new token by calling the 'token_refresher' callback. - When 'proactive_refresh' is enabled, the Credential object must be either run within a context manager - or the 'close' method must be called once the object usage has been finished. - :raises: TypeError if paramater 'token' is not a string - :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' callable. - """ - - _ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2 - _DEFAULT_AUTOREFRESH_INTERVAL_MINUTES = 10 - - def __init__(self, token: str, **kwargs: Any): - if not isinstance(token, str): - raise TypeError("Token must be a string.") - self._token = create_access_token(token) - self._token_refresher = kwargs.pop("token_refresher", None) - self._proactive_refresh = kwargs.pop("proactive_refresh", False) - if self._proactive_refresh and self._token_refresher is None: - raise ValueError("When 'proactive_refresh' is True, 'token_refresher' must not be None.") - self._timer = None - self._lock = Condition(Lock()) - self._some_thread_refreshing = False - self._is_closed = Event() - - def get_token(self, *scopes, **kwargs): # pylint: disable=unused-argument - # type (*str, **Any) -> AccessToken - """The value of the configured token. - :param any scopes: Scopes to be added to the token. - :return: AccessToken - :rtype: ~azure.core.credentials.AccessToken - """ - if self._proactive_refresh and self._is_closed.is_set(): - raise RuntimeError("An instance of CommunicationTokenCredential cannot be reused once it has been closed.") - - if not self._token_refresher or not self._is_token_expiring_soon(self._token): - return self._token - self._update_token_and_reschedule() - return self._token - - def _update_token_and_reschedule(self): - should_this_thread_refresh = False - with self._lock: - while self._is_token_expiring_soon(self._token): - if self._some_thread_refreshing: - if self._is_token_valid(self._token): - return self._token - self._wait_till_lock_owner_finishes_refreshing() - else: - should_this_thread_refresh = True - self._some_thread_refreshing = True - break - - if should_this_thread_refresh: - try: - new_token = self._token_refresher() - if not self._is_token_valid(new_token): - raise ValueError("The token returned from the token_refresher is expired.") - with self._lock: - self._token = new_token - self._some_thread_refreshing = False - self._lock.notify_all() - except: - with self._lock: - self._some_thread_refreshing = False - self._lock.notify_all() - raise - if self._proactive_refresh: - self._schedule_refresh() - return self._token - - def _schedule_refresh(self): - if self._is_closed.is_set(): - return - if self._timer is not None: - self._timer.cancel() - - token_ttl = self._token.expires_on - get_current_utc_as_int() - - if self._is_token_expiring_soon(self._token): - # Schedule the next refresh for when it reaches a certain percentage of the remaining lifetime. - timespan = token_ttl // 2 - else: - # Schedule the next refresh for when it gets in to the soon-to-expire window. - timespan = token_ttl - timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES).total_seconds() - if timespan <= TIMEOUT_MAX: - self._timer = Timer(timespan, self._update_token_and_reschedule) - self._timer.daemon = True - self._timer.start() - - def _wait_till_lock_owner_finishes_refreshing(self): - self._lock.release() - self._lock.acquire() - - def _is_token_expiring_soon(self, token): - if self._proactive_refresh: - interval = timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES) - else: - interval = timedelta(minutes=self._ON_DEMAND_REFRESHING_INTERVAL_MINUTES) - return (token.expires_on - get_current_utc_as_int()) < interval.total_seconds() - - @classmethod - def _is_token_valid(cls, token): - return get_current_utc_as_int() < token.expires_on - - def __enter__(self): - if self._proactive_refresh: - if self._is_closed.is_set(): - raise RuntimeError( - "An instance of CommunicationTokenCredential cannot be reused once it has been closed." - ) - self._schedule_refresh() - return self - - def __exit__(self, *args): - self.close() - - def close(self) -> None: - if self._timer is not None: - self._timer.cancel() - self._timer = None - self._is_closed.set() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py deleted file mode 100644 index 15ad17da1a8c4..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py +++ /dev/null @@ -1,148 +0,0 @@ -# ------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- - -from asyncio import Condition, Lock, Event -from datetime import timedelta -from typing import Any -import sys - -from .utils import get_current_utc_as_int -from .utils import create_access_token -from .utils_async import AsyncTimer - - -class CommunicationTokenCredential(object): - """Credential type used for authenticating to an Azure Communication service. - :param str token: The token used to authenticate to an Azure Communication service. - :keyword token_refresher: The async token refresher to provide capacity to fetch a fresh token. - The returned token must be valid (expiration date must be in the future). - :paramtype token_refresher: Callable[[], Awaitable[AccessToken]] - :keyword bool proactive_refresh: Whether to refresh the token proactively or not. - If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use - a background thread to attempt to refresh the token within 10 minutes before the cached token expires, - the proactive refresh will request a new token by calling the 'token_refresher' callback. - When 'proactive_refresh is enabled', the Credential object must be either run within a context manager - or the 'close' method must be called once the object usage has been finished. - :raises: TypeError if paramater 'token' is not a string - :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' function. - """ - - _ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2 - _DEFAULT_AUTOREFRESH_INTERVAL_MINUTES = 10 - - def __init__(self, token: str, **kwargs: Any): - if not isinstance(token, str): - raise TypeError("Token must be a string.") - self._token = create_access_token(token) - self._token_refresher = kwargs.pop("token_refresher", None) - self._proactive_refresh = kwargs.pop("proactive_refresh", False) - if self._proactive_refresh and self._token_refresher is None: - raise ValueError("When 'proactive_refresh' is True, 'token_refresher' must not be None.") - self._timer = None - self._async_mutex = Lock() - if sys.version_info[:3] == (3, 10, 0): - # Workaround for Python 3.10 bug(https://bugs.python.org/issue45416): - getattr(self._async_mutex, "_get_loop", lambda: None)() - self._lock = Condition(self._async_mutex) - self._some_thread_refreshing = False - self._is_closed = Event() - - async def get_token(self, *scopes, **kwargs): # pylint: disable=unused-argument - # type (*str, **Any) -> AccessToken - """The value of the configured token. - :param any scopes: Scopes to be added to the token. - :return: AccessToken - :rtype: ~azure.core.credentials.AccessToken - """ - if self._proactive_refresh and self._is_closed.is_set(): - raise RuntimeError("An instance of CommunicationTokenCredential cannot be reused once it has been closed.") - - if not self._token_refresher or not self._is_token_expiring_soon(self._token): - return self._token - await self._update_token_and_reschedule() - return self._token - - async def _update_token_and_reschedule(self): - should_this_thread_refresh = False - async with self._lock: - while self._is_token_expiring_soon(self._token): - if self._some_thread_refreshing: - if self._is_token_valid(self._token): - return self._token - await self._wait_till_lock_owner_finishes_refreshing() - else: - should_this_thread_refresh = True - self._some_thread_refreshing = True - break - - if should_this_thread_refresh: - try: - new_token = await self._token_refresher() - if not self._is_token_valid(new_token): - raise ValueError("The token returned from the token_refresher is expired.") - async with self._lock: - self._token = new_token - self._some_thread_refreshing = False - self._lock.notify_all() - except: - async with self._lock: - self._some_thread_refreshing = False - self._lock.notify_all() - raise - if self._proactive_refresh: - self._schedule_refresh() - return self._token - - def _schedule_refresh(self): - if self._is_closed.is_set(): - return - if self._timer is not None: - self._timer.cancel() - - token_ttl = self._token.expires_on - get_current_utc_as_int() - - if self._is_token_expiring_soon(self._token): - # Schedule the next refresh for when it reaches a certain percentage of the remaining lifetime. - timespan = token_ttl // 2 - else: - # Schedule the next refresh for when it gets in to the soon-to-expire window. - timespan = token_ttl - timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES).total_seconds() - - self._timer = AsyncTimer(timespan, self._update_token_and_reschedule) - self._timer.start() - - async def _wait_till_lock_owner_finishes_refreshing(self): - self._lock.release() - await self._lock.acquire() - - def _is_token_expiring_soon(self, token): - if self._proactive_refresh: - interval = timedelta(minutes=self._DEFAULT_AUTOREFRESH_INTERVAL_MINUTES) - else: - interval = timedelta(minutes=self._ON_DEMAND_REFRESHING_INTERVAL_MINUTES) - return (token.expires_on - get_current_utc_as_int()) < interval.total_seconds() - - @classmethod - def _is_token_valid(cls, token): - return get_current_utc_as_int() < token.expires_on - - async def __aenter__(self): - if self._proactive_refresh: - if self._is_closed.is_set(): - raise RuntimeError( - "An instance of CommunicationTokenCredential cannot be reused once it has been closed." - ) - self._schedule_refresh() - return self - - async def __aexit__(self, *args): - await self.close() - - async def close(self) -> None: - if self._timer is not None: - self._timer.cancel() - self._timer = None - self._is_closed.set() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py deleted file mode 100644 index 8576c31ddc56a..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils.py +++ /dev/null @@ -1,93 +0,0 @@ -# ------------------------------------------------------------------------ -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# ------------------------------------------------------------------------- - -import base64 -import json -import calendar -from typing import cast, Tuple, Optional -from datetime import datetime -from azure.core.serialization import TZ_UTC -from azure.core.credentials import AccessToken - - -def _convert_datetime_to_utc_int(input_datetime) -> int: - """ - Converts DateTime in local time to the Epoch in UTC in second. - - :param input_datetime: Input datetime - :type input_datetime: datetime - :return: Integer - :rtype: int - """ - return int(calendar.timegm(input_datetime.utctimetuple())) - - -def parse_connection_str(conn_str): - # type: (Optional[str]) -> Tuple[str, str] - if conn_str is None: - raise ValueError("Connection string is undefined.") - endpoint = None - shared_access_key = None - for element in conn_str.split(";"): - key, _, value = element.partition("=") - if key.lower() == "endpoint": - endpoint = value.rstrip("/") - elif key.lower() == "accesskey": - shared_access_key = value - if not all([endpoint, shared_access_key]): - raise ValueError( - "Invalid connection string. You can get the connection string from your resource page in the Azure Portal. " - "The format should be as follows: endpoint=https:///;accesskey=" - ) - left_slash_pos = cast(str, endpoint).find("//") - if left_slash_pos != -1: - host = cast(str, endpoint)[left_slash_pos + 2 :] - else: - host = str(endpoint) - - return host, str(shared_access_key) - - -def get_current_utc_time(): - # type: () -> str - return str(datetime.now(tz=TZ_UTC).strftime("%a, %d %b %Y %H:%M:%S ")) + "GMT" - - -def get_current_utc_as_int(): - # type: () -> int - current_utc_datetime = datetime.utcnow() - return _convert_datetime_to_utc_int(current_utc_datetime) - - -def create_access_token(token): - # type: (str) -> AccessToken - """Creates an instance of azure.core.credentials.AccessToken from a - string token. The input string is jwt token in the following form: - .. - This method looks into the token_payload which is a json and extracts the expiry time - for that token and creates a tuple of type azure.core.credentials.AccessToken - (, ) - :param token: User token - :type token: str - :return: Instance of azure.core.credentials.AccessToken - token and expiry date of it - :rtype: ~azure.core.credentials.AccessToken - """ - - token_parse_err_msg = "Token is not formatted correctly" - parts = token.split(".") - - if len(parts) < 3: - raise ValueError(token_parse_err_msg) - - try: - padded_base64_payload = base64.b64decode(parts[1] + "==").decode("ascii") - payload = json.loads(padded_base64_payload) - return AccessToken( - token, - _convert_datetime_to_utc_int(datetime.fromtimestamp(payload["exp"], TZ_UTC)), - ) - except ValueError as val_error: - raise ValueError(token_parse_err_msg) from val_error diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py deleted file mode 100644 index 86e0e04d273c0..0000000000000 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py +++ /dev/null @@ -1,31 +0,0 @@ -# ------------------------------------------------------------------------ -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# ------------------------------------------------------------------------- - -import asyncio - - -class AsyncTimer: - """A non-blocking timer, that calls a function after a specified number of seconds: - :param int interval: time interval in seconds - :param callable callback: function to be called after the interval has elapsed - """ - - def __init__(self, interval, callback): - self._interval = interval - self._callback = callback - self._task = None - - def start(self): - self._task = asyncio.ensure_future(self._job()) - - async def _job(self): - await asyncio.sleep(self._interval) - await self._callback() - - def cancel(self): - if self._task is not None: - self._task.cancel() - self._task = None diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py index 69423791b4916..ad8505048a225 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_vendor.py @@ -16,18 +16,19 @@ from ._serialization import Deserializer, Serializer -class NotificationMessagesClientMixinABC( - ABC -): + +class NotificationMessagesClientMixinABC(ABC): """DO NOT use this class. It is for internal typing use only.""" + _client: "PipelineClient" _config: NotificationMessagesClientConfiguration _serialize: "Serializer" _deserialize: "Deserializer" -class MessageTemplateClientMixinABC( - ABC -): + + +class MessageTemplateClientMixinABC(ABC): """DO NOT use this class. It is for internal typing use only.""" + _client: "PipelineClient" _config: MessageTemplateClientConfiguration _serialize: "Serializer" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py index 83602e6274bc2..0ec13ea52bbf5 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.1" +VERSION = "1.0.0" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py index 6d57d158f591f..f6f164b437559 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/__init__.py @@ -15,9 +15,10 @@ except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk + __all__ = [ - 'NotificationMessagesClient', - 'MessageTemplateClient', + "NotificationMessagesClient", + "MessageTemplateClient", ] __all__.extend([p for p in _patch_all if p not in __all__]) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py index 1e83e764793ad..8b6d84b3bcffe 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, Awaitable, TYPE_CHECKING, Union +from typing_extensions import Self from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential @@ -22,13 +23,16 @@ # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class NotificationMessagesClient(NotificationMessagesClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + +class NotificationMessagesClient( + NotificationMessagesClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword """NotificationMessagesClient. :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -38,35 +42,35 @@ class NotificationMessagesClient(NotificationMessagesClientOperationsMixin): # """ def __init__( - self, - endpoint: str, - credential: Union["AsyncTokenCredential", AzureKeyCredential], - **kwargs: Any + self, endpoint: str, credential: Union["AsyncTokenCredential", AzureKeyCredential], **kwargs: Any ) -> None: - _endpoint = '{endpoint}' + _endpoint = "{endpoint}" self._config = NotificationMessagesClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - _policies = kwargs.pop('policies', None) + _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] + _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 + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. @@ -87,7 +91,7 @@ def send_request( 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) @@ -96,19 +100,21 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "NotificationMessagesClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self async def __aexit__(self, *exc_details: Any) -> None: await self._client.__aexit__(*exc_details) + + class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword """MessageTemplateClient. :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -118,35 +124,35 @@ class MessageTemplateClient(MessageTemplateClientOperationsMixin): # pylint: di """ def __init__( - self, - endpoint: str, - credential: Union["AsyncTokenCredential", AzureKeyCredential], - **kwargs: Any + self, endpoint: str, credential: Union["AsyncTokenCredential", AzureKeyCredential], **kwargs: Any ) -> None: - _endpoint = '{endpoint}' + _endpoint = "{endpoint}" self._config = MessageTemplateClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - _policies = kwargs.pop('policies', None) + _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] + _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 + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. @@ -167,7 +173,7 @@ def send_request( 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) @@ -176,7 +182,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "MessageTemplateClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py index 5308b452aca65..5d31ab4f1a693 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_configuration.py @@ -18,7 +18,7 @@ from azure.core.credentials_async import AsyncTokenCredential -class NotificationMessagesClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class NotificationMessagesClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for NotificationMessagesClient. Note that all parameters used to create this instance are saved as instance @@ -27,7 +27,7 @@ class NotificationMessagesClientConfiguration: # pylint: disable=too-many-ins :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -37,12 +37,9 @@ class NotificationMessagesClientConfiguration: # pylint: disable=too-many-ins """ def __init__( - self, - endpoint: str, - credential: Union["AsyncTokenCredential", AzureKeyCredential], - **kwargs: Any + self, endpoint: str, credential: Union["AsyncTokenCredential", AzureKeyCredential], **kwargs: Any ) -> None: - api_version: str = kwargs.pop('api_version', "2024-02-01") + api_version: str = kwargs.pop("api_version", "2024-02-01") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -52,34 +49,33 @@ def __init__( self.endpoint = endpoint self.credential = credential self.api_version = api_version - self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) - kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.credential_scopes = kwargs.pop("credential_scopes", ["https://communication.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "communication-messages/{}".format(VERSION)) self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _infer_policy(self, **kwargs): - if hasattr(self.credential, 'get_token'): + if hasattr(self.credential, "get_token"): return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) if isinstance(self.credential, AzureKeyCredential): return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **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') + 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) -class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + + +class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long """Configuration for MessageTemplateClient. Note that all parameters used to create this instance are saved as instance @@ -88,7 +84,7 @@ class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance :param endpoint: The communication resource, for example https://my-resource.communication.azure.com. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Is either a + :param credential: Credential used to authenticate requests to the service. Is either a TokenCredential type or a AzureKeyCredential type. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential or ~azure.core.credentials.AzureKeyCredential @@ -98,12 +94,9 @@ class MessageTemplateClientConfiguration: # pylint: disable=too-many-instance """ def __init__( - self, - endpoint: str, - credential: Union["AsyncTokenCredential", AzureKeyCredential], - **kwargs: Any + self, endpoint: str, credential: Union["AsyncTokenCredential", AzureKeyCredential], **kwargs: Any ) -> None: - api_version: str = kwargs.pop('api_version', "2024-02-01") + api_version: str = kwargs.pop("api_version", "2024-02-01") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") @@ -113,30 +106,27 @@ def __init__( self.endpoint = endpoint self.credential = credential self.api_version = api_version - self.credential_scopes = kwargs.pop('credential_scopes', ['https://communication.azure.com/.default']) - kwargs.setdefault('sdk_moniker', 'communication-messages/{}'.format(VERSION)) + self.credential_scopes = kwargs.pop("credential_scopes", ["https://communication.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "communication-messages/{}".format(VERSION)) self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _infer_policy(self, **kwargs): - if hasattr(self.credential, 'get_token'): + if hasattr(self.credential, "get_token"): return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) if isinstance(self.credential, AzureKeyCredential): return policies.AzureKeyCredentialPolicy(self.credential, "Authorization", **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') + 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/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py index b610e644f4c28..5a3a47e6ff3a5 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/__init__.py @@ -12,9 +12,10 @@ from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk + __all__ = [ - 'NotificationMessagesClientOperationsMixin', - 'MessageTemplateClientOperationsMixin', + "NotificationMessagesClientOperationsMixin", + "MessageTemplateClientOperationsMixin", ] __all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py index f754eb60ef331..78f769218dd13 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_operations/_operations.py @@ -9,16 +9,18 @@ from io import IOBase import json import sys -from typing import Any, AsyncIterable, AsyncIterator, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +from typing import Any, AsyncIterable, AsyncIterator, Callable, Dict, IO, List, Optional, Type, 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.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 @@ -27,35 +29,31 @@ from ... import models as _models from ..._model_base import SdkJSONEncoder, _deserialize -from ..._operations._operations import (build_message_template_list_templates_request, - build_notification_messages_download_media_request, - build_notification_messages_send_request) +from ..._operations._operations import ( + build_message_template_list_templates_request, + build_notification_messages_download_media_request, + build_notification_messages_send_request, +) from .._vendor import MessageTemplateClientMixinABC, NotificationMessagesClientMixinABC 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') +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] -class NotificationMessagesClientOperationsMixin( # pylint: disable=name-too-long - NotificationMessagesClientMixinABC -): + +class NotificationMessagesClientOperationsMixin(NotificationMessagesClientMixinABC): # pylint: disable=name-too-long @overload async def send( - self, - body: _models.NotificationContent, - *, - content_type: str = "application/json", - **kwargs: Any + self, body: _models.NotificationContent, *, content_type: str = "application/json", **kwargs: Any ) -> _models.SendMessageResult: - # pylint: disable=line-too-long """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: ~azure.communication.messages.models.NotificationContent :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -72,36 +70,29 @@ async def send( # JSON input template for discriminator value "image": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "image", - "mediaUri": "str", # A media url for the file. Required if the type is one - of the supported media types, e.g. image. Required. + "mediaUri": "str", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ], - "content": "str" # Optional. Optional text content. + "content": "str" } # JSON input template for discriminator value "template": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "template", "template": { - "language": "str", # The template's language, in the ISO 639 format, - consist of a two-letter language code followed by an optional two-letter - country code, e.g., 'en' or 'en_US'. Required. - "name": "str", # Name of the template. Required. + "language": "str", + "name": "str", "bindings": message_template_bindings, "values": [ message_template_value ] }, "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -110,41 +101,34 @@ async def send( "kind": "whatsApp", "body": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "buttons": [ { - "refValue": "str", # The name of the referenced item in the - template values. Required. - "subType": "str" # The WhatsApp button sub type. Required. - Known values are: "quickReply" and "url". + "refValue": "str", + "subType": "str" } ], "footer": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "header": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ] } # JSON input template for discriminator value "text": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. - "content": "str", # Message content. Required. + "channelRegistrationId": "str", + "content": "str", "kind": "text", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -155,9 +139,8 @@ async def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } @@ -165,15 +148,11 @@ async def send( @overload async def send( - self, - body: JSON, - *, - content_type: str = "application/json", - **kwargs: Any + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.SendMessageResult: """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -189,9 +168,8 @@ async def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } @@ -199,15 +177,11 @@ async def send( @overload async def send( - self, - body: IO[bytes], - *, - content_type: str = "application/json", - **kwargs: Any + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.SendMessageResult: """Sends a notification message from Business to User. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -223,25 +197,21 @@ async def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } """ - @distributed_trace_async async def send( - self, - body: Union[_models.NotificationContent, JSON, IO[bytes]], - **kwargs: Any + self, body: Union[_models.NotificationContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.SendMessageResult: - # pylint: disable=line-too-long """Sends a notification message from Business to User. - :param body: Is one of the following types: NotificationContent, JSON, IO[bytes] Required. + :param body: Body parameter. Is one of the following types: NotificationContent, JSON, + IO[bytes] Required. :type body: ~azure.communication.messages.models.NotificationContent or JSON or IO[bytes] :return: SendMessageResult. The SendMessageResult is compatible with MutableMapping :rtype: ~azure.communication.messages.models.SendMessageResult @@ -255,36 +225,29 @@ async def send( # JSON input template for discriminator value "image": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "image", - "mediaUri": "str", # A media url for the file. Required if the type is one - of the supported media types, e.g. image. Required. + "mediaUri": "str", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ], - "content": "str" # Optional. Optional text content. + "content": "str" } # JSON input template for discriminator value "template": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. + "channelRegistrationId": "str", "kind": "template", "template": { - "language": "str", # The template's language, in the ISO 639 format, - consist of a two-letter language code followed by an optional two-letter - country code, e.g., 'en' or 'en_US'. Required. - "name": "str", # Name of the template. Required. + "language": "str", + "name": "str", "bindings": message_template_bindings, "values": [ message_template_value ] }, "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -293,41 +256,34 @@ async def send( "kind": "whatsApp", "body": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "buttons": [ { - "refValue": "str", # The name of the referenced item in the - template values. Required. - "subType": "str" # The WhatsApp button sub type. Required. - Known values are: "quickReply" and "url". + "refValue": "str", + "subType": "str" } ], "footer": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ], "header": [ { - "refValue": "str" # The name of the referenced item in the - template values. Required. + "refValue": "str" } ] } # JSON input template for discriminator value "text": notification_content = { - "channelRegistrationId": "str", # The Channel Registration ID for the - Business Identifier. Required. - "content": "str", # Message content. Required. + "channelRegistrationId": "str", + "content": "str", "kind": "text", "to": [ - "str" # The native external platform user identifiers of the - recipient. Required. + "str" ] } @@ -338,25 +294,25 @@ async def send( response == { "receipts": [ { - "messageId": "str", # The message id. Required. - "to": "str" # The native external platform user identifier - of the recipient. Required. + "messageId": "str", + "to": "str" } ] } """ - error_map = { - 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + 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.SendMessageResult] = kwargs.pop( - 'cls', None - ) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.SendMessageResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -373,50 +329,43 @@ async def send( params=_params, ) 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.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 + _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 + 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['Repeatability-Result']=self._deserialize('str', response.headers.get('Repeatability-Result')) - response_headers['x-ms-client-request-id']=self._deserialize('str', response.headers.get('x-ms-client-request-id')) + response_headers["Repeatability-Result"] = self._deserialize( + "str", response.headers.get("Repeatability-Result") + ) + response_headers["x-ms-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize( - _models.SendMessageResult, - response.json() - ) + deserialized = _deserialize(_models.SendMessageResult, response.json()) if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized # type: ignore - - @distributed_trace_async - async def download_media( - self, - id: str, - **kwargs: Any - ) -> AsyncIterator[bytes]: + async def download_media(self, id: str, **kwargs: Any) -> AsyncIterator[bytes]: """Download the Media payload from a User to Business message. :param id: The stream ID. Required. @@ -425,20 +374,18 @@ async def download_media( :rtype: AsyncIterator[bytes] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, - 304: ResourceNotModifiedError + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + error_map.update(kwargs.pop("error_map", {}) or {}) _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[AsyncIterator[bytes]] = kwargs.pop( - 'cls', None - ) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) _request = build_notification_messages_download_media_request( id=id, @@ -447,47 +394,40 @@ async def download_media( params=_params, ) 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.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 + _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 + 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-client-request-id"] = self._deserialize( + "str", response.headers.get("x-ms-client-request-id") + ) deserialized = response.iter_bytes() if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore + return cls(pipeline_response, deserialized, response_headers) # type: ignore return deserialized # type: ignore -class MessageTemplateClientOperationsMixin( - MessageTemplateClientMixinABC -): + +class MessageTemplateClientOperationsMixin(MessageTemplateClientMixinABC): @distributed_trace - def list_templates( - self, - channel_id: str, - **kwargs: Any - ) -> AsyncIterable["_models.MessageTemplateItem"]: - # pylint: disable=line-too-long + def list_templates(self, channel_id: str, **kwargs: Any) -> AsyncIterable["_models.MessageTemplateItem"]: """List all templates for given Azure Communication Services channel. :param channel_id: The registration ID of the channel. Required. @@ -506,14 +446,10 @@ def list_templates( # JSON input template for discriminator value "whatsApp": message_template_item = { "kind": "whatsApp", - "language": "str", # The template's language, in the ISO 639 format, consist - of a two-letter language code followed by an optional two-letter country code, - e.g., 'en' or 'en_US'. Required. - "name": "str", # The template's name. Required. - "status": "str", # The aggregated template status. Required. Known values - are: "approved", "rejected", "pending", and "paused". - "content": {} # Optional. WhatsApp platform's template content. This is the - payload returned from WhatsApp API. + "language": "str", + "name": "str", + "status": "str", + "content": {} } # response body for status code(s): 200 @@ -523,16 +459,19 @@ def list_templates( _params = kwargs.pop("params", {}) or {} maxpagesize = kwargs.pop("maxpagesize", None) - cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop( - 'cls', None - ) + cls: ClsType[List[_models.MessageTemplateItem]] = kwargs.pop("cls", None) - error_map = { - 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, 304: ResourceNotModifiedError + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, } - error_map.update(kwargs.pop('error_map', {}) or {}) + error_map.update(kwargs.pop("error_map", {}) or {}) + def prepare_request(next_link=None): if not next_link: + _request = build_message_template_list_templates_request( channel_id=channel_id, maxpagesize=maxpagesize, @@ -541,19 +480,29 @@ def prepare_request(next_link=None): params=_params, ) 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.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 = 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) + _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), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -563,7 +512,7 @@ async def extract_data(pipeline_response): deserialized = pipeline_response.http_response.json() list_of_elem = _deserialize(List[_models.MessageTemplateItem], deserialized["value"]) if cls: - list_of_elem = cls(list_of_elem) # type: ignore + 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): @@ -571,21 +520,14 @@ async def get_next(next_link=None): _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]: - 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 - ) + return AsyncItemPaged(get_next, extract_data) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py index 409152840451a..d69ae3068ceba 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_patch.py @@ -22,6 +22,7 @@ from .._api_versions import DEFAULT_VERSION from .._shared.auth_policy_utils import get_authentication_policy + class NotificationMessagesClient(NotificationMessagesClientGenerated): """A client to interact with the AzureCommunicationService Messaging service. @@ -37,8 +38,9 @@ class NotificationMessagesClient(NotificationMessagesClientGenerated): Note that overriding this default value may result in unsupported behavior. """ - def __init__(self, endpoint: str, - credential: Union[AsyncTokenCredential, AzureKeyCredential], **kwargs: Any) -> None: + def __init__( + self, endpoint: str, credential: Union[AsyncTokenCredential, AzureKeyCredential], **kwargs: Any + ) -> None: if not credential: raise ValueError("credential can not be None") @@ -54,11 +56,14 @@ def __init__(self, endpoint: str, self._endpoint = endpoint self._credential = credential - self._authentication_policy = get_authentication_policy(endpoint, credential) + self._authentication_policy = get_authentication_policy(endpoint, credential) self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) super().__init__( - self._endpoint, self._credential, - authentication_policy=self._authentication_policy, api_version=self._api_version, **kwargs + self._endpoint, + self._credential, + authentication_policy=self._authentication_policy, + api_version=self._api_version, + **kwargs ) @classmethod @@ -73,6 +78,7 @@ def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "NotificationMe endpoint, access_key = parse_connection_str(conn_str) return cls(endpoint, AzureKeyCredential(key=access_key), **kwargs) + class MessageTemplateClient(MessageTemplateClientGenerated): """A client to interact with the AzureCommunicationService Messaging service. @@ -88,8 +94,9 @@ class MessageTemplateClient(MessageTemplateClientGenerated): :paramtype api_version: str """ - def __init__(self, endpoint: str, credential: Union[AsyncTokenCredential, - AzureKeyCredential], **kwargs: Any) -> "None": + def __init__( + self, endpoint: str, credential: Union[AsyncTokenCredential, AzureKeyCredential], **kwargs: Any + ) -> "None": if not credential: raise ValueError("credential can not be None") @@ -105,10 +112,11 @@ def __init__(self, endpoint: str, credential: Union[AsyncTokenCredential, self._endpoint = endpoint self._credential = credential - self._authentication_policy = get_authentication_policy(endpoint, credential) + self._authentication_policy = get_authentication_policy(endpoint, credential) self._api_version = kwargs.pop("api_version", DEFAULT_VERSION) super().__init__( - self._endpoint, self._credential, + self._endpoint, + self._credential, authentication_policy=self._authentication_policy, api_version=self._api_version, **kwargs @@ -126,11 +134,13 @@ def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "MessageTemplat endpoint, access_key = parse_connection_str(conn_str) return cls(endpoint, AzureKeyCredential(access_key), **kwargs) + __all__: List[str] = [ "NotificationMessagesClient", "MessageTemplateClient", ] # Add all objects you want publicly available to users at this package level + def patch_sdk(): """Do not remove from this file. diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py index 8181c1e90e24d..e5c42048e8a2c 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/aio/_vendor.py @@ -16,18 +16,19 @@ from .._serialization import Deserializer, Serializer -class NotificationMessagesClientMixinABC( - ABC -): + +class NotificationMessagesClientMixinABC(ABC): """DO NOT use this class. It is for internal typing use only.""" + _client: "AsyncPipelineClient" _config: NotificationMessagesClientConfiguration _serialize: "Serializer" _deserialize: "Deserializer" -class MessageTemplateClientMixinABC( - ABC -): + + +class MessageTemplateClientMixinABC(ABC): """DO NOT use this class. It is for internal typing use only.""" + _client: "AsyncPipelineClient" _config: MessageTemplateClientConfiguration _serialize: "Serializer" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py index 033c45805634e..15af588cfd43f 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/__init__.py @@ -6,7 +6,7 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._models import ImageNotificationContent +from ._models import MediaNotificationContent from ._models import MessageReceipt from ._models import MessageTemplate from ._models import MessageTemplateBindings @@ -37,34 +37,35 @@ from ._patch import __all__ as _patch_all from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk + __all__ = [ - 'ImageNotificationContent', - 'MessageReceipt', - 'MessageTemplate', - 'MessageTemplateBindings', - 'MessageTemplateDocument', - 'MessageTemplateImage', - 'MessageTemplateItem', - 'MessageTemplateLocation', - 'MessageTemplateQuickAction', - 'MessageTemplateText', - 'MessageTemplateValue', - 'MessageTemplateVideo', - 'NotificationContent', - 'SendMessageResult', - 'TemplateNotificationContent', - 'TextNotificationContent', - 'WhatsAppMessageTemplateBindings', - 'WhatsAppMessageTemplateBindingsButton', - 'WhatsAppMessageTemplateBindingsComponent', - 'WhatsAppMessageTemplateItem', - 'CommunicationMessageKind', - 'CommunicationMessagesChannel', - 'MessageTemplateBindingsKind', - 'MessageTemplateStatus', - 'MessageTemplateValueKind', - 'RepeatabilityResult', - 'WhatsAppMessageButtonSubType', + "MediaNotificationContent", + "MessageReceipt", + "MessageTemplate", + "MessageTemplateBindings", + "MessageTemplateDocument", + "MessageTemplateImage", + "MessageTemplateItem", + "MessageTemplateLocation", + "MessageTemplateQuickAction", + "MessageTemplateText", + "MessageTemplateValue", + "MessageTemplateVideo", + "NotificationContent", + "SendMessageResult", + "TemplateNotificationContent", + "TextNotificationContent", + "WhatsAppMessageTemplateBindings", + "WhatsAppMessageTemplateBindingsButton", + "WhatsAppMessageTemplateBindingsComponent", + "WhatsAppMessageTemplateItem", + "CommunicationMessageKind", + "CommunicationMessagesChannel", + "MessageTemplateBindingsKind", + "MessageTemplateStatus", + "MessageTemplateValueKind", + "RepeatabilityResult", + "WhatsAppMessageButtonSubType", ] __all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py index ba0b05de2243d..6917541c1af86 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_enums.py @@ -11,8 +11,7 @@ class CommunicationMessageKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The type of message. Supports text, image, template. - """ + """The type of message. Supports text, image, template.""" TEXT = "text" """Text message type.""" @@ -21,23 +20,23 @@ class CommunicationMessageKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): TEMPLATE = "template" """Template message type.""" + class CommunicationMessagesChannel(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The type of the communication messages channel. - """ + """The type of the communication messages channel.""" - WHATSAPP = "whatsApp" + WHATS_APP = "whatsApp" """The WhatsApp communication messages channel type.""" + class MessageTemplateBindingsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The type of the message template. - """ + """The type of the message template.""" - WHATSAPP = "whatsApp" + WHATS_APP = "whatsApp" """The WhatsApp template type.""" + class MessageTemplateStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The aggregated template status. - """ + """The aggregated template status.""" APPROVED = "approved" """Message template is approved.""" @@ -48,9 +47,9 @@ class MessageTemplateStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): PAUSED = "paused" """Message template is paused.""" + class MessageTemplateValueKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The type of the template parameter. - """ + """The type of the template parameter.""" TEXT = "text" """The text template parameter type.""" @@ -65,9 +64,9 @@ class MessageTemplateValueKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): QUICK_ACTION = "quickAction" """The quick action template parameter type.""" + class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Repeatability Result header options. - """ + """Repeatability Result header options.""" ACCEPTED = "accepted" """If the request was accepted and the server guarantees that the server state reflects a single @@ -78,9 +77,9 @@ class RepeatabilityResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): or because the Repeatability-First-Sent value was outside the range of values held by the server.""" + class WhatsAppMessageButtonSubType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The WhatsApp button sub type. - """ + """The WhatsApp button sub type.""" QUICK_REPLY = "quickReply" """The WhatsApp button sub type is quick reply.""" diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py index 635dfc8397419..952893cd97626 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/models/_models.py @@ -11,10 +11,12 @@ from .. import _model_base from .._model_base import rest_discriminator, rest_field -from ._enums import (CommunicationMessageKind, - CommunicationMessagesChannel, - MessageTemplateBindingsKind, - MessageTemplateValueKind) +from ._enums import ( + CommunicationMessageKind, + CommunicationMessagesChannel, + MessageTemplateBindingsKind, + MessageTemplateValueKind, +) if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports @@ -25,7 +27,7 @@ class NotificationContent(_model_base.Model): """Details of the message to send. You probably want to use the sub-classes and not this class directly. Known sub-classes are: - ImageNotificationContent, TemplateNotificationContent, TextNotificationContent + MediaNotificationContent, TemplateNotificationContent, TextNotificationContent All required parameters must be populated in order to send to server. @@ -48,7 +50,6 @@ class NotificationContent(_model_base.Model): """The type discriminator describing a notification type. Required. Known values are: \"text\", \"image\", and \"template\".""" - @overload def __init__( self, @@ -56,8 +57,7 @@ def __init__( channel_registration_id: str, to: List[str], kind: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -66,12 +66,12 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) -class ImageNotificationContent(NotificationContent, discriminator='image'): - """A request to send a media image notification. +class MediaNotificationContent(NotificationContent, discriminator="image"): + """A request to send a media notification. All required parameters must be populated in order to send to server. @@ -84,7 +84,7 @@ class ImageNotificationContent(NotificationContent, discriminator='image'): :vartype kind: str or ~azure.communication.messages.models.IMAGE :ivar content: Optional text content. :vartype content: str - :ivar media_uri: A media url for the image file. Required if the type is one of the supported media + :ivar media_uri: A media url for the file. Required if the type is one of the supported media types, e.g. image. Required. :vartype media_uri: str """ @@ -97,7 +97,6 @@ class ImageNotificationContent(NotificationContent, discriminator='image'): """A media url for the file. Required if the type is one of the supported media types, e.g. image. Required.""" - @overload def __init__( self, @@ -106,8 +105,7 @@ def __init__( to: List[str], media_uri: str, content: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -116,14 +114,13 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=CommunicationMessageKind.IMAGE, **kwargs) class MessageReceipt(_model_base.Model): """Receipt of the sending one message. - All required parameters must be populated in order to send to server. :ivar message_id: The message id. Required. :vartype message_id: str @@ -136,15 +133,13 @@ class MessageReceipt(_model_base.Model): to: str = rest_field() """The native external platform user identifier of the recipient. Required.""" - @overload def __init__( self, *, message_id: str, to: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -153,7 +148,7 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) @@ -183,7 +178,6 @@ class MessageTemplate(_model_base.Model): bindings: Optional["_models.MessageTemplateBindings"] = rest_field() """The binding object to link values to the template specific locations.""" - @overload def __init__( self, @@ -192,8 +186,7 @@ def __init__( language: str, template_values: Optional[List["_models.MessageTemplateValue"]] = None, bindings: Optional["_models.MessageTemplateBindings"] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -202,7 +195,7 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) @@ -222,14 +215,12 @@ class MessageTemplateBindings(_model_base.Model): kind: str = rest_discriminator(name="kind") """The type discriminator describing a template bindings type. Required. \"whatsApp\"""" - @overload def __init__( self, *, kind: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -238,7 +229,7 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) @@ -265,15 +256,13 @@ class MessageTemplateValue(_model_base.Model): """The type discriminator describing a template parameter type. Required. Known values are: \"text\", \"image\", \"document\", \"video\", \"location\", and \"quickAction\".""" - @overload def __init__( self, *, name: str, kind: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -282,11 +271,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) -class MessageTemplateDocument(MessageTemplateValue, discriminator='document'): +class MessageTemplateDocument(MessageTemplateValue, discriminator="document"): """The message template's document value information. All required parameters must be populated in order to send to server. @@ -312,7 +301,6 @@ class MessageTemplateDocument(MessageTemplateValue, discriminator='document'): file_name: Optional[str] = rest_field(name="fileName") """The [optional] filename of the media file.""" - @overload def __init__( self, @@ -321,8 +309,7 @@ def __init__( url: str, caption: Optional[str] = None, file_name: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -331,11 +318,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.DOCUMENT, **kwargs) -class MessageTemplateImage(MessageTemplateValue, discriminator='image'): +class MessageTemplateImage(MessageTemplateValue, discriminator="image"): """The message template's image value information. All required parameters must be populated in order to send to server. @@ -361,7 +348,6 @@ class MessageTemplateImage(MessageTemplateValue, discriminator='image'): file_name: Optional[str] = rest_field(name="fileName") """The [optional] filename of the media file.""" - @overload def __init__( self, @@ -370,8 +356,7 @@ def __init__( url: str, caption: Optional[str] = None, file_name: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -380,9 +365,10 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.IMAGE, **kwargs) + class MessageTemplateItem(_model_base.Model): """The message template as returned from the service. @@ -391,7 +377,6 @@ class MessageTemplateItem(_model_base.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 name: The template's name. Required. :vartype name: str @@ -417,7 +402,6 @@ class MessageTemplateItem(_model_base.Model): kind: str = rest_discriminator(name="kind") """The type discriminator describing a template type. Required. \"whatsApp\"""" - @overload def __init__( self, @@ -425,8 +409,7 @@ def __init__( language: str, status: Union[str, "_models.MessageTemplateStatus"], kind: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -435,11 +418,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) -class MessageTemplateLocation(MessageTemplateValue, discriminator='location'): +class MessageTemplateLocation(MessageTemplateValue, discriminator="location"): """The message template's location value information. All required parameters must be populated in order to send to server. @@ -469,7 +452,6 @@ class MessageTemplateLocation(MessageTemplateValue, discriminator='location'): longitude: float = rest_field() """The longitude of the location. Required.""" - @overload def __init__( self, @@ -479,8 +461,7 @@ def __init__( longitude: float, location_name: Optional[str] = None, address: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -489,11 +470,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.LOCATION, **kwargs) -class MessageTemplateQuickAction(MessageTemplateValue, discriminator='quickAction'): +class MessageTemplateQuickAction(MessageTemplateValue, discriminator="quickAction"): """The message template's quick action value information. All required parameters must be populated in order to send to server. @@ -516,7 +497,6 @@ class MessageTemplateQuickAction(MessageTemplateValue, discriminator='quickActio payload: Optional[str] = rest_field() """The [Optional] quick action payload.""" - @overload def __init__( self, @@ -524,8 +504,7 @@ def __init__( name: str, text: Optional[str] = None, payload: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -534,11 +513,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.QUICK_ACTION, **kwargs) -class MessageTemplateText(MessageTemplateValue, discriminator='text'): +class MessageTemplateText(MessageTemplateValue, discriminator="text"): """The message template's text value information. All required parameters must be populated in order to send to server. @@ -556,15 +535,13 @@ class MessageTemplateText(MessageTemplateValue, discriminator='text'): text: str = rest_field() """The text value. Required.""" - @overload def __init__( self, *, name: str, text: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -573,11 +550,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.TEXT, **kwargs) -class MessageTemplateVideo(MessageTemplateValue, discriminator='video'): +class MessageTemplateVideo(MessageTemplateValue, discriminator="video"): """The message template's video value information. All required parameters must be populated in order to send to server. @@ -603,7 +580,6 @@ class MessageTemplateVideo(MessageTemplateValue, discriminator='video'): file_name: Optional[str] = rest_field(name="fileName") """The [optional] filename of the media file.""" - @overload def __init__( self, @@ -612,8 +588,7 @@ def __init__( url: str, caption: Optional[str] = None, file_name: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -622,14 +597,13 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=MessageTemplateValueKind.VIDEO, **kwargs) class SendMessageResult(_model_base.Model): """Result of the send message operation. - All required parameters must be populated in order to send to server. :ivar receipts: Receipts of the send message operation. Required. :vartype receipts: list[~azure.communication.messages.models.MessageReceipt] @@ -638,14 +612,12 @@ class SendMessageResult(_model_base.Model): receipts: List["_models.MessageReceipt"] = rest_field() """Receipts of the send message operation. Required.""" - @overload def __init__( self, *, receipts: List["_models.MessageReceipt"], - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -654,11 +626,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) -class TemplateNotificationContent(NotificationContent, discriminator='template'): +class TemplateNotificationContent(NotificationContent, discriminator="template"): """A request to send a template notification. All required parameters must be populated in order to send to server. @@ -679,7 +651,6 @@ class TemplateNotificationContent(NotificationContent, discriminator='template') template: "_models.MessageTemplate" = rest_field() """The template object used to create templates. Required.""" - @overload def __init__( self, @@ -687,8 +658,7 @@ def __init__( channel_registration_id: str, to: List[str], template: "_models.MessageTemplate", - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -697,11 +667,11 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=CommunicationMessageKind.TEMPLATE, **kwargs) -class TextNotificationContent(NotificationContent, discriminator='text'): +class TextNotificationContent(NotificationContent, discriminator="text"): """A request to send a text notification. All required parameters must be populated in order to send to server. @@ -722,7 +692,6 @@ class TextNotificationContent(NotificationContent, discriminator='text'): content: str = rest_field() """Message content. Required.""" - @overload def __init__( self, @@ -730,8 +699,7 @@ def __init__( channel_registration_id: str, to: List[str], content: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -740,16 +708,17 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, kind=CommunicationMessageKind.TEXT, **kwargs) -class WhatsAppMessageTemplateBindings(MessageTemplateBindings, discriminator='whatsApp'): + +class WhatsAppMessageTemplateBindings(MessageTemplateBindings, discriminator="whatsApp"): """The template bindings for WhatsApp. All required parameters must be populated in order to send to server. :ivar kind: MessageTemplateBindings is whatsApp. Required. The WhatsApp template type. - :vartype kind: str or ~azure.communication.messages.models.WHATSAPP + :vartype kind: str or ~azure.communication.messages.models.WHATS_APP :ivar header: The header template bindings. :vartype header: list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsComponent] @@ -764,7 +733,7 @@ class WhatsAppMessageTemplateBindings(MessageTemplateBindings, discriminator='wh list[~azure.communication.messages.models.WhatsAppMessageTemplateBindingsButton] """ - kind: Literal[MessageTemplateBindingsKind.WHATSAPP] = rest_discriminator(name="kind") # type: ignore + kind: Literal[MessageTemplateBindingsKind.WHATS_APP] = rest_discriminator(name="kind") # type: ignore """MessageTemplateBindings is whatsApp. Required. The WhatsApp template type.""" header: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = rest_field() """The header template bindings.""" @@ -775,7 +744,6 @@ class WhatsAppMessageTemplateBindings(MessageTemplateBindings, discriminator='wh buttons: Optional[List["_models.WhatsAppMessageTemplateBindingsButton"]] = rest_field() """The button template bindings.""" - @overload def __init__( self, @@ -784,8 +752,7 @@ def __init__( body: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = None, footer: Optional[List["_models.WhatsAppMessageTemplateBindingsComponent"]] = None, buttons: Optional[List["_models.WhatsAppMessageTemplateBindingsButton"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -794,8 +761,9 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation - super().__init__(*args, kind=MessageTemplateBindingsKind.WHATSAPP, **kwargs) + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=MessageTemplateBindingsKind.WHATS_APP, **kwargs) + class WhatsAppMessageTemplateBindingsButton(_model_base.Model): """The template bindings component button for WhatsApp. @@ -814,15 +782,13 @@ class WhatsAppMessageTemplateBindingsButton(_model_base.Model): ref_value: str = rest_field(name="refValue") """The name of the referenced item in the template values. Required.""" - @overload def __init__( self, *, sub_type: Union[str, "_models.WhatsAppMessageButtonSubType"], ref_value: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -831,9 +797,10 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) + class WhatsAppMessageTemplateBindingsComponent(_model_base.Model): """The template bindings component for WhatsApp. @@ -846,14 +813,12 @@ class WhatsAppMessageTemplateBindingsComponent(_model_base.Model): ref_value: str = rest_field(name="refValue") """The name of the referenced item in the template values. Required.""" - @overload def __init__( self, *, ref_value: str, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -862,15 +827,15 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation super().__init__(*args, **kwargs) -class WhatsAppMessageTemplateItem(MessageTemplateItem, discriminator='whatsApp'): + +class WhatsAppMessageTemplateItem(MessageTemplateItem, discriminator="whatsApp"): """The WhatsApp-specific template response contract. 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 name: The template's name. Required. :vartype name: str @@ -885,16 +850,15 @@ class WhatsAppMessageTemplateItem(MessageTemplateItem, discriminator='whatsApp') :vartype content: any :ivar kind: Message template response type is whatsApp. Required. The WhatsApp communication messages channel type. - :vartype kind: str or ~azure.communication.messages.models.WHATSAPP + :vartype kind: str or ~azure.communication.messages.models.WHATS_APP """ content: Optional[Any] = rest_field() """WhatsApp platform's template content. This is the payload returned from WhatsApp API.""" - kind: Literal[CommunicationMessagesChannel.WHATSAPP] = rest_discriminator(name="kind") # type: ignore + kind: Literal[CommunicationMessagesChannel.WHATS_APP] = rest_discriminator(name="kind") # type: ignore """Message template response type is whatsApp. Required. The WhatsApp communication messages channel type.""" - @overload def __init__( self, @@ -902,8 +866,7 @@ def __init__( language: str, status: Union[str, "_models.MessageTemplateStatus"], content: Optional[Any] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -912,5 +875,5 @@ def __init__(self, mapping: Mapping[str, Any]): :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None:# pylint: disable=useless-super-delegation - super().__init__(*args, kind=CommunicationMessagesChannel.WHATSAPP, **kwargs) + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, kind=CommunicationMessagesChannel.WHATS_APP, **kwargs) diff --git a/sdk/communication/azure-communication-messages/samples/get_templates_list.py b/sdk/communication/azure-communication-messages/samples/get_templates_list.py index 7c8f71b12f515..91e6a1c76abcc 100644 --- a/sdk/communication/azure-communication-messages/samples/get_templates_list.py +++ b/sdk/communication/azure-communication-messages/samples/get_templates_list.py @@ -25,25 +25,26 @@ sys.path.append("..") + class GetTemplatesSample(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + def get_templates_list(self): from azure.communication.messages import MessageTemplateClient - from azure.communication.messages.models import ( TextNotificationContent ) + from azure.communication.messages.models import TextNotificationContent message_template_client = MessageTemplateClient.from_connection_string(self.connection_string) - + # calling send() with whatsapp message details template_list = message_template_client.list_templates(self.channel_id) - + count_templates = len(list(template_list)) - print("Successfully retrieved {} templates from channel_id {}." - .format(count_templates, self.channel_id)) + print("Successfully retrieved {} templates from channel_id {}.".format(count_templates, self.channel_id)) + -if __name__ == '__main__': +if __name__ == "__main__": sample = GetTemplatesSample() sample.get_templates_list() diff --git a/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py b/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py index 4114851b5a751..261767c07d803 100644 --- a/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py +++ b/sdk/communication/azure-communication-messages/samples/get_templates_list_async.py @@ -26,28 +26,30 @@ sys.path.append("..") + class GetTemplatesSampleAsync(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + async def get_templates_list_async(self): from azure.communication.messages.aio import MessageTemplateClient message_template_client = MessageTemplateClient.from_connection_string(self.connection_string) - + # calling send() with whatsapp message details async with message_template_client: template_list = message_template_client.list_templates(self.channel_id) async_list_data = [x async for x in template_list] count_templates = len(list(async_list_data)) - print("Successfully retrieved {} templates from channel_id {}." - .format(count_templates, self.channel_id)) + print("Successfully retrieved {} templates from channel_id {}.".format(count_templates, self.channel_id)) + async def main(): sample = GetTemplatesSampleAsync() await sample.get_templates_list_async() -if __name__ == '__main__': + +if __name__ == "__main__": asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py index 5f2b10fd0f088..dcf8132871887 100644 --- a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py +++ b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages.py @@ -26,12 +26,13 @@ sys.path.append("..") + class SendWhatsAppMessageSample(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + def send_image_send_message(self): from azure.communication.messages import NotificationMessagesClient @@ -41,17 +42,17 @@ def send_image_send_message(self): image_options = ImageNotificationContent( channel_registration_id=self.channel_id, - to=[self.phone_number], + to=[self.phone_number], content="Hello World via Notification Messaging SDK.", - media_uri="https://aka.ms/acsicon1" + media_uri="https://aka.ms/acsicon1", ) - + # calling send() with whatsapp message details message_responses = messaging_client.send(image_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) + -if __name__ == '__main__': +if __name__ == "__main__": sample = SendWhatsAppMessageSample() sample.send_image_send_message() diff --git a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py index e1260c87e171c..df8f4a72e18fe 100644 --- a/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py +++ b/sdk/communication/azure-communication-messages/samples/send_image_notification_messages_async.py @@ -28,12 +28,13 @@ sys.path.append("..") + class SendWhatsAppMessageSampleAsync(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + async def send_image_send_message_async(self): from azure.communication.messages.aio import NotificationMessagesClient from azure.communication.messages.models import ImageNotificationContent @@ -43,22 +44,22 @@ async def send_image_send_message_async(self): image_options = ImageNotificationContent( channel_registration_id=self.channel_id, - to= [self.phone_number], + to=[self.phone_number], content="Hello World via Notification Messaging SDK.", - media_uri="https://aka.ms/acsicon1" + media_uri="https://aka.ms/acsicon1", ) - + # calling send() with whatsapp message details async with messaging_client: message_responses = await messaging_client.send(image_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) + async def main(): sample = SendWhatsAppMessageSampleAsync() await sample.send_image_send_message_async() -if __name__ == '__main__': +if __name__ == "__main__": asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py index cc96ca387cccf..7819ece7ac98e 100644 --- a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py +++ b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages.py @@ -28,12 +28,13 @@ sys.path.append("..") + class SendWhatsAppTemplateMessageSample(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + def send_template_send_message(self): from azure.communication.messages import NotificationMessagesClient @@ -43,19 +44,18 @@ def send_template_send_message(self): # Setting template options input_template: MessageTemplate = MessageTemplate( - name="gathering_invitation", # Name of the WhatsApp Template - language="ca") # Language of the WhatsApp Template + name="gathering_invitation", language="ca" # Name of the WhatsApp Template + ) # Language of the WhatsApp Template template_options = TemplateNotificationContent( - channel_registration_id= self.channel_id, - to=[self.phone_number], - template=input_template) - + channel_registration_id=self.channel_id, to=[self.phone_number], template=input_template + ) + # calling send() with whatsapp message details message_responses = messaging_client.send(template_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) + -if __name__ == '__main__': +if __name__ == "__main__": sample = SendWhatsAppTemplateMessageSample() sample.send_template_send_message() diff --git a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py index 43412257e2253..d3d2d4d268742 100644 --- a/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py +++ b/sdk/communication/azure-communication-messages/samples/send_template_notification_messages_async.py @@ -29,12 +29,13 @@ sys.path.append("..") + class SendWhatsAppTemplateMessageSampleAsync(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + async def send_template_send_message_async(self): from azure.communication.messages.aio import NotificationMessagesClient from azure.communication.messages.models import TemplateNotificationContent, MessageTemplate @@ -43,24 +44,23 @@ async def send_template_send_message_async(self): # Setting template options input_template: MessageTemplate = MessageTemplate( - name="gathering_invitation", # Name of the WhatsApp Template - language="ca") # Language of the WhatsApp Template + name="gathering_invitation", language="ca" # Name of the WhatsApp Template + ) # Language of the WhatsApp Template template_options = TemplateNotificationContent( - channel_registration_id= self.channel_id, - to=[self.phone_number], - template=input_template) - + channel_registration_id=self.channel_id, to=[self.phone_number], template=input_template + ) + # calling send() with whatsapp message details async with messaging_client: - message_responses =await messaging_client.send(template_options) + message_responses = await messaging_client.send(template_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) async def main(): sample = SendWhatsAppTemplateMessageSampleAsync() await sample.send_template_send_message_async() -if __name__ == '__main__': + +if __name__ == "__main__": asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py index cb229b4e3fabf..390ae2f5d28b0 100644 --- a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages.py @@ -26,12 +26,13 @@ sys.path.append("..") + class SendWhatsAppMessageSample(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + def send_text_send_message(self): from azure.communication.messages import NotificationMessagesClient @@ -41,16 +42,16 @@ def send_text_send_message(self): text_options = TextNotificationContent( channel_registration_id=self.channel_id, - to=[self.phone_number], + to=[self.phone_number], content="Hello World via Notification Messaging SDK.", ) - + # calling send() with whatsapp message details message_responses = messaging_client.send(text_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) + -if __name__ == '__main__': +if __name__ == "__main__": sample = SendWhatsAppMessageSample() sample.send_text_send_message() diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py index 3669995e623a0..5b7cdfe4d88d5 100644 --- a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_async.py @@ -28,12 +28,13 @@ sys.path.append("..") + class SendWhatsAppMessageSampleAsync(object): connection_string = os.getenv("COMMUNICATION_SAMPLES_CONNECTION_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + async def send_text_send_message_async(self): from azure.communication.messages.aio import NotificationMessagesClient from azure.communication.messages.models import TextNotificationContent @@ -46,13 +47,12 @@ async def send_text_send_message_async(self): to=[self.phone_number], content="Hello World via Notification Messaging SDK.", ) - + # calling send() with whatsapp message details async with messaging_client: message_responses = await messaging_client.send(text_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) async def main(): @@ -60,5 +60,5 @@ async def main(): await sample.send_text_send_message_async() -if __name__ == '__main__': +if __name__ == "__main__": asyncio.run(main()) diff --git a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py index 0e67babf40a77..4f61bec2136e2 100644 --- a/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py +++ b/sdk/communication/azure-communication-messages/samples/send_text_notification_messages_with_token_credentials.py @@ -34,33 +34,35 @@ sys.path.append("..") + class SendWhatsAppMessageSample(object): endpoint_string = os.getenv("COMMUNICATION_SAMPLES_ENDPOINT_STRING") phone_number = os.getenv("RECIPIENT_PHONE_NUMBER") channel_id = os.getenv("WHATSAPP_CHANNEL_ID") - + def send_text_send_message(self): from azure.communication.messages import NotificationMessagesClient from azure.communication.messages.models import TextNotificationContent from azure.identity import DefaultAzureCredential - messaging_client = NotificationMessagesClient(endpoint=self.endpoint_string, - credential=DefaultAzureCredential()) + messaging_client = NotificationMessagesClient( + endpoint=self.endpoint_string, credential=DefaultAzureCredential() + ) text_options = TextNotificationContent( channel_registration_id=self.channel_id, - to=[self.phone_number], + to=[self.phone_number], content="Hello World via Notification Messaging SDK using Token credentials.", ) - + # calling send() with whatsapp message details message_responses = messaging_client.send(text_options) response = message_responses.receipts[0] - print("Message with message id {} was successful sent to {}" - .format(response.message_id, response.to)) + print("Message with message id {} was successful sent to {}".format(response.message_id, response.to)) + -if __name__ == '__main__': +if __name__ == "__main__": sample = SendWhatsAppMessageSample() sample.send_text_send_message() diff --git a/sdk/communication/azure-communication-messages/setup.py b/sdk/communication/azure-communication-messages/setup.py index 7429140abb451..c0d6b48794c6a 100644 --- a/sdk/communication/azure-communication-messages/setup.py +++ b/sdk/communication/azure-communication-messages/setup.py @@ -63,8 +63,8 @@ "azure.communication.messages": ["py.typed"], }, install_requires=[ - "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.30.0", + "isodate>=0.6.1", + "azure-core>=1.30.0", "typing-extensions>=4.6.0", ], python_requires=">=3.8", diff --git a/sdk/communication/azure-communication-messages/tests/_decorators.py b/sdk/communication/azure-communication-messages/tests/_decorators.py index aadf9f57f1544..b03a05540dd62 100644 --- a/sdk/communication/azure-communication-messages/tests/_decorators.py +++ b/sdk/communication/azure-communication-messages/tests/_decorators.py @@ -10,6 +10,7 @@ from devtools_testutils import is_live, is_live_and_not_recording, trim_kwargs_from_test_function from azure.communication.messages._shared.utils import parse_connection_str + class MessagesPreparers(object): @staticmethod @@ -21,10 +22,11 @@ def wrapper(self, *args, **kwargs): self.resource_name = endpoint.split(".")[0] else: - self.connection_string = "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + self.connection_string = ( + "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + ) self.resource_name = "sanitized" func(self, *args, **kwargs) return wrapper - diff --git a/sdk/communication/azure-communication-messages/tests/_decorators_async.py b/sdk/communication/azure-communication-messages/tests/_decorators_async.py index c7514f1ed993f..3776cabeb2888 100644 --- a/sdk/communication/azure-communication-messages/tests/_decorators_async.py +++ b/sdk/communication/azure-communication-messages/tests/_decorators_async.py @@ -10,6 +10,7 @@ from devtools_testutils import is_live, is_live_and_not_recording, trim_kwargs_from_test_function from azure.communication.messages._shared.utils import parse_connection_str + class MessagesPreparersAsync(object): @staticmethod @@ -21,13 +22,15 @@ async def wrapper(self, *args, **kwargs): self.resource_name = endpoint.split(".")[0] else: - self.connection_string = "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + self.connection_string = ( + "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" + ) self.resource_name = "sanitized" return await func(self, *args, **kwargs) return wrapper - + @staticmethod def messages_test_decorator_for_token_async(func: Callable[[], object], **kwargs: Any): async def wrapper(self, *args, **kwargs): diff --git a/sdk/communication/azure-communication-messages/tests/_messages_test_case.py b/sdk/communication/azure-communication-messages/tests/_messages_test_case.py index dfcaa01dc6166..998bfd2bf618c 100644 --- a/sdk/communication/azure-communication-messages/tests/_messages_test_case.py +++ b/sdk/communication/azure-communication-messages/tests/_messages_test_case.py @@ -12,13 +12,14 @@ ) from devtools_testutils import AzureRecordedTestCase + class MessagesRecordedTestCase(AzureRecordedTestCase): def create_notification_message_client(self) -> NotificationMessagesClient: return NotificationMessagesClient.from_connection_string( conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() ) - + def create_notification_message_client_from_token(self) -> NotificationMessagesClient: return NotificationMessagesClient.from_token_credentials( endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() @@ -28,8 +29,8 @@ def create_message_template_client(self) -> MessageTemplateClient: return MessageTemplateClient.from_connection_string( conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() ) - + def create_message_template_client_from_token(self) -> MessageTemplateClient: return MessageTemplateClient.from_token_credentials( endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() - ) \ No newline at end of file + ) diff --git a/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py b/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py index 5951f64a48bfc..384e26ba468c8 100644 --- a/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py +++ b/sdk/communication/azure-communication-messages/tests/_messages_test_case_async.py @@ -13,13 +13,14 @@ ) from devtools_testutils import AzureRecordedTestCase + class AsyncMessagesRecordedTestCase(AzureRecordedTestCase): def create_notification_message_client(self) -> NotificationMessagesClient: return NotificationMessagesClient.from_connection_string( conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() ) - + def create_notification_message_client_from_token(self) -> NotificationMessagesClient: return NotificationMessagesClient.from_token_credentials( endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() @@ -29,8 +30,8 @@ def create_message_template_client(self) -> MessageTemplateClient: return MessageTemplateClient.from_connection_string( conn_str=self.connection_string, http_logging_policy=get_http_logging_policy() ) - + def create_message_template_client_from_token(self) -> MessageTemplateClient: return MessageTemplateClient.from_token_credentials( endpoint=self.endpoint_str, http_logging_policy=get_http_logging_policy() - ) \ No newline at end of file + ) diff --git a/sdk/communication/azure-communication-messages/tests/_shared/utils.py b/sdk/communication/azure-communication-messages/tests/_shared/utils.py index 536e680d8fed3..ea71205f0e7ad 100644 --- a/sdk/communication/azure-communication-messages/tests/_shared/utils.py +++ b/sdk/communication/azure-communication-messages/tests/_shared/utils.py @@ -54,7 +54,7 @@ def get_header_policy(**kwargs): return header_policy -def parse_connection_str(conn_str:str) -> Tuple[str, str]: +def parse_connection_str(conn_str: str) -> Tuple[str, str]: if conn_str is None: raise ValueError("Connection string is undefined.") endpoint = None diff --git a/sdk/communication/azure-communication-messages/tests/conftest.py b/sdk/communication/azure-communication-messages/tests/conftest.py index e3524c0d8e350..bd0a6705d6285 100644 --- a/sdk/communication/azure-communication-messages/tests/conftest.py +++ b/sdk/communication/azure-communication-messages/tests/conftest.py @@ -34,25 +34,27 @@ add_body_key_sanitizer, add_oauth_response_sanitizer, add_general_string_sanitizer, - add_general_regex_sanitizer) + add_general_regex_sanitizer, +) from azure.communication.messages._shared.utils import parse_connection_str + # autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method @pytest.fixture(scope="session", autouse=True) def start_proxy(test_proxy): set_default_session_settings() add_oauth_response_sanitizer() - + FAKE_CONNECTION_STRING = "endpoint=https://sanitized.unitedstates.communication.azure.com/;accesskey=fake===" FAKE_ENDPOINT = "sanitized.unitedstates.communication.azure.com" - connection_str = os.environ.get('COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING', FAKE_CONNECTION_STRING) + connection_str = os.environ.get("COMMUNICATION_LIVETEST_DYNAMIC_CONNECTION_STRING", FAKE_CONNECTION_STRING) if connection_str is not None: endpoint, _ = parse_connection_str(connection_str) resource_name = endpoint.split(".")[0] add_general_string_sanitizer(target=resource_name, value="sanitized") add_general_regex_sanitizer(regex=connection_str, value=FAKE_CONNECTION_STRING) add_general_regex_sanitizer(regex=endpoint, value=FAKE_ENDPOINT) - + add_general_string_sanitizer(target="8f8c29b2-c2e4-4340-bb28-3009c8a57283", value="sanitized") add_body_key_sanitizer(json_path="channel_registration_id", value="sanitized") add_body_key_sanitizer(json_path="*.channel_registration_id", value="sanitized") @@ -76,7 +78,6 @@ def start_proxy(test_proxy): add_body_key_sanitizer(json_path="*.repeatability-first-sent", value="sanitized") add_body_key_sanitizer(json_path="*..repeatability-first-sent", value="sanitized") - add_header_regex_sanitizer(key="P3P", value="sanitized") add_header_regex_sanitizer(key="Set-Cookie", value="sanitized") add_header_regex_sanitizer(key="Date", value="sanitized") @@ -92,4 +93,4 @@ def start_proxy(test_proxy): add_header_regex_sanitizer(key="Content-Security-Policy-Report-Only", value="sanitized") add_header_regex_sanitizer(key="repeatability-first-sent", value="sanitized") add_header_regex_sanitizer(key="repeatability-request-id", value="sanitized") - return \ No newline at end of file + return diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_client.py b/sdk/communication/azure-communication-messages/tests/test_messages_client.py index fdb7c6ef037b9..de3d612dfb5f5 100644 --- a/sdk/communication/azure-communication-messages/tests/test_messages_client.py +++ b/sdk/communication/azure-communication-messages/tests/test_messages_client.py @@ -20,26 +20,28 @@ MessageTemplateBindings, MessageTemplateValue, WhatsAppMessageTemplateBindings, - WhatsAppMessageTemplateBindingsComponent - ) + WhatsAppMessageTemplateBindingsComponent, +) from _shared.utils import get_http_logging_policy from _messages_test_case import MessagesRecordedTestCase from azure.communication.messages._shared.utils import parse_connection_str - + + class TestNotificationMessageClientForText(MessagesRecordedTestCase): @MessagesPreparers.messages_test_decorator - @recorded_by_proxy + @recorded_by_proxy def test_text_send_message(self): phone_number: str = "+14254360097" raised = False text_options = TextNotificationContent( channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to= [phone_number], - content="Thanks for your feedback Hello.") + to=[phone_number], + content="Thanks for your feedback Hello.", + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -53,24 +55,20 @@ def test_text_send_message(self): assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparers.messages_test_decorator - @recorded_by_proxy + @recorded_by_proxy def test_template_send_message(self): phone_number: str = "+14254360097" - input_template: MessageTemplate = MessageTemplate( - name="gathering_invitation", - language="ca") + input_template: MessageTemplate = MessageTemplate(name="gathering_invitation", language="ca") raised = False message_client: NotificationMessagesClient = self.create_notification_message_client() template_options = TemplateNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - template=input_template) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], template=input_template + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None try: with message_client: @@ -82,35 +80,29 @@ def test_template_send_message(self): assert raised is False assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparers.messages_test_decorator - @recorded_by_proxy + @recorded_by_proxy def test_template_with_parameters_send_message(self): - + phone_number: str = "+14254360097" - parammeter1 = MessageTemplateText ( - name="first", - text="11-18-2024" - ) + parammeter1 = MessageTemplateText(name="first", text="11-18-2024") input_template: MessageTemplate = MessageTemplate( name="gathering_invitation", language="en_US", - template_values= [parammeter1], - bindings=WhatsAppMessageTemplateBindings - ( - body= [ WhatsAppMessageTemplateBindingsComponent(ref_value="first")] - ) - ) + template_values=[parammeter1], + bindings=WhatsAppMessageTemplateBindings( + body=[WhatsAppMessageTemplateBindingsComponent(ref_value="first")] + ), + ) raised = False template_options = TemplateNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - template=input_template) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], template=input_template + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -125,18 +117,17 @@ def test_template_with_parameters_send_message(self): assert message_response.to is not None @MessagesPreparers.messages_test_decorator - @recorded_by_proxy + @recorded_by_proxy def test_image_send_message(self): phone_number: str = "+14254360097" input_media_uri: str = "https://aka.ms/acsicon1" raised = False template_options = ImageNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - media_uri=input_media_uri) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], media_uri=input_media_uri + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -149,10 +140,9 @@ def test_image_send_message(self): assert raised is False assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparers.messages_test_decorator - @recorded_by_proxy + @recorded_by_proxy def test_download_media(self): phone_number: str = "+14254360097" input_media_id: str = "8f8c29b2-c2e4-4340-bb28-3009c8a57283" @@ -165,4 +155,4 @@ def test_download_media(self): raised = True raise assert raised is False - assert media_stream is not None \ No newline at end of file + assert media_stream is not None diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py b/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py index 1db009a8ad2b4..a84a4b295a18c 100644 --- a/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py +++ b/sdk/communication/azure-communication-messages/tests/test_messages_client_async.py @@ -21,26 +21,28 @@ MessageTemplateBindings, MessageTemplateValue, WhatsAppMessageTemplateBindings, - WhatsAppMessageTemplateBindingsComponent - ) + WhatsAppMessageTemplateBindingsComponent, +) from _shared.utils import get_http_logging_policy from _messages_test_case_async import AsyncMessagesRecordedTestCase from azure.communication.messages._shared.utils import parse_connection_str - + + class TestNotificationMessageClientForTextAsync(AsyncMessagesRecordedTestCase): - @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @MessagesPreparersAsync.messages_test_decorator_async + @recorded_by_proxy_async async def test_text_send_message_async(self): phone_number: str = "+14254360097" raised = False text_options = TextNotificationContent( channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to= [phone_number], - content="Thanks for your feedback Hello.") + to=[phone_number], + content="Thanks for your feedback Hello.", + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -54,24 +56,20 @@ async def test_text_send_message_async(self): assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @recorded_by_proxy_async async def test_template_send_message_async(self): phone_number: str = "+14254360097" - input_template: MessageTemplate = MessageTemplate( - name="gathering_invitation", - language="ca") + input_template: MessageTemplate = MessageTemplate(name="gathering_invitation", language="ca") raised = False message_client: NotificationMessagesClient = self.create_notification_message_client() template_options = TemplateNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - template=input_template) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], template=input_template + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None try: async with message_client: @@ -83,35 +81,29 @@ async def test_template_send_message_async(self): assert raised is False assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @recorded_by_proxy_async async def test_template_with_parameters_send_message_async(self): - + phone_number: str = "+14254360097" - parammeter1 = MessageTemplateText ( - name="first", - text="11-18-2024" - ) + parammeter1 = MessageTemplateText(name="first", text="11-18-2024") input_template: MessageTemplate = MessageTemplate( name="gathering_invitation", language="en_US", - template_values= [parammeter1], - bindings=WhatsAppMessageTemplateBindings - ( - body= [ WhatsAppMessageTemplateBindingsComponent(ref_value="first")] - ) - ) + template_values=[parammeter1], + bindings=WhatsAppMessageTemplateBindings( + body=[WhatsAppMessageTemplateBindingsComponent(ref_value="first")] + ), + ) raised = False template_options = TemplateNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - template=input_template) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], template=input_template + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -126,18 +118,17 @@ async def test_template_with_parameters_send_message_async(self): assert message_response.to is not None @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @recorded_by_proxy_async async def test_image_send_message_async(self): phone_number: str = "+14254360097" input_media_uri: str = "https://aka.ms/acsicon1" raised = False template_options = ImageNotificationContent( - channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", - to=[phone_number], - media_uri=input_media_uri) + channel_registration_id="b045be8c-45cd-492a-b2a2-47bae7c36959", to=[phone_number], media_uri=input_media_uri + ) - message_response : MessageReceipt = None + message_response: MessageReceipt = None message_client: NotificationMessagesClient = self.create_notification_message_client() try: @@ -150,10 +141,9 @@ async def test_image_send_message_async(self): assert raised is False assert message_response.message_id is not None assert message_response.to is not None - @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @recorded_by_proxy_async async def test_download_media_async(self): phone_number: str = "+14254360097" input_media_id: str = "8f8c29b2-c2e4-4340-bb28-3009c8a57283" @@ -166,4 +156,4 @@ async def test_download_media_async(self): raised = True raise assert raised is False - assert media_stream is not None \ No newline at end of file + assert media_stream is not None diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_template_client.py b/sdk/communication/azure-communication-messages/tests/test_messages_template_client.py index c4ebb00328e5a..3fe9b48523fa0 100644 --- a/sdk/communication/azure-communication-messages/tests/test_messages_template_client.py +++ b/sdk/communication/azure-communication-messages/tests/test_messages_template_client.py @@ -6,14 +6,12 @@ from devtools_testutils import recorded_by_proxy from _decorators import MessagesPreparers -from azure.communication.messages.models import ( - MessageTemplateItem, - MessageTemplate - ) +from azure.communication.messages.models import MessageTemplateItem, MessageTemplate from _shared.utils import get_http_logging_policy from _messages_test_case import MessagesRecordedTestCase from azure.communication.messages._shared.utils import parse_connection_str - + + class TestMessageTemplateClientToGetTemplates(MessagesRecordedTestCase): @MessagesPreparers.messages_test_decorator @@ -30,6 +28,6 @@ def test_get_templates(self): except: raised = True raise - + assert raised is False assert message_template_item_list is not None diff --git a/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py b/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py index 070494a878bd0..31726352db10a 100644 --- a/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py +++ b/sdk/communication/azure-communication-messages/tests/test_messages_template_client_async.py @@ -6,18 +6,16 @@ from devtools_testutils.aio import recorded_by_proxy_async from _decorators_async import MessagesPreparersAsync -from azure.communication.messages.models import ( - MessageTemplateItem, - MessageTemplate - ) +from azure.communication.messages.models import MessageTemplateItem, MessageTemplate from _shared.utils import get_http_logging_policy from _messages_test_case_async import AsyncMessagesRecordedTestCase from azure.communication.messages._shared.utils import parse_connection_str - + + class TestMessageTemplateClientToGetTemplatesAsync(AsyncMessagesRecordedTestCase): @MessagesPreparersAsync.messages_test_decorator_async - @recorded_by_proxy_async + @recorded_by_proxy_async async def test_get_templates_async(self): channel_id = "b045be8c-45cd-492a-b2a2-47bae7c36959" raised = False @@ -30,9 +28,6 @@ async def test_get_templates_async(self): except: raised = True raise - + assert raised is False assert message_template_item_list is not None - - - diff --git a/sdk/communication/azure-communication-messages/tests/unittest_helpers.py b/sdk/communication/azure-communication-messages/tests/unittest_helpers.py index 9d24a0aa86ebb..3bc29f4ede4bf 100644 --- a/sdk/communication/azure-communication-messages/tests/unittest_helpers.py +++ b/sdk/communication/azure-communication-messages/tests/unittest_helpers.py @@ -7,6 +7,7 @@ from unittest import mock + def mock_response(status_code=200, headers=None, json_payload=None): response = mock.Mock(status_code=status_code, headers=headers or {}) if json_payload is not None: diff --git a/sdk/communication/azure-communication-messages/tsp-location.yaml b/sdk/communication/azure-communication-messages/tsp-location.yaml index e8d5cb2bd4a13..87df2e182747c 100644 --- a/sdk/communication/azure-communication-messages/tsp-location.yaml +++ b/sdk/communication/azure-communication-messages/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/communication/Communication.Messages -commit: 392938969db1bb682734600b9a5c0f0a30a95f58 +commit: 228acac22c34fa19cd629ba2df005822ab8ba959 repo: Azure/azure-rest-api-specs -additionalDirectories: [] +additionalDirectories: diff --git a/sdk/developer-signing/azure-developer-signing/CHANGELOG.md b/sdk/developer-signing/azure-developer-signing/CHANGELOG.md new file mode 100644 index 0000000000000..628743d283a92 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (1970-01-01) + +- Initial version diff --git a/sdk/developer-signing/azure-developer-signing/LICENSE b/sdk/developer-signing/azure-developer-signing/LICENSE new file mode 100644 index 0000000000000..63447fd8bbbf7 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/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/developer-signing/azure-developer-signing/MANIFEST.in b/sdk/developer-signing/azure-developer-signing/MANIFEST.in new file mode 100644 index 0000000000000..003574fbe20e0 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/developer/signing/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/developer/__init__.py \ No newline at end of file diff --git a/sdk/developer-signing/azure-developer-signing/README.md b/sdk/developer-signing/azure-developer-signing/README.md new file mode 100644 index 0000000000000..8f4be2da9b81b --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/README.md @@ -0,0 +1,80 @@ + + +# Azure Developer Signing client library for Python + + +## Getting started + +### Install the package + +```bash +python -m pip install azure-developer-signing +``` + +#### 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 Developer Signing 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.developer.signing import SigningClient +>>> from azure.identity import DefaultAzureCredential +>>> client = SigningClient(endpoint='', credential=DefaultAzureCredential()) +``` + +## Examples + +```python +>>> from azure.developer.signing import SigningClient +>>> from azure.identity import DefaultAzureCredential +>>> from azure.core.exceptions import HttpResponseError + +>>> client = SigningClient(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/developer-signing/azure-developer-signing/_meta.json b/sdk/developer-signing/azure-developer-signing/_meta.json new file mode 100644 index 0000000000000..7768212a3557c --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/_meta.json @@ -0,0 +1,7 @@ +{ + "commit": "228acac22c34fa19cd629ba2df005822ab8ba959", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/developersigning/DeveloperSigning", + "@azure-tools/typespec-python": "0.24.3", + "@autorest/python": "6.14.3" +} \ No newline at end of file diff --git a/sdk/developer-signing/azure-developer-signing/azure/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/__init__.py new file mode 100644 index 0000000000000..d55ccad1f573f --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/__init__.py new file mode 100644 index 0000000000000..c903ddf386633 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/__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 SigningClient +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__ = [ + "SigningClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_client.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_client.py new file mode 100644 index 0000000000000..7931077fd837a --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_client.py @@ -0,0 +1,107 @@ +# 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 typing_extensions import Self + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import SigningClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import CertificateProfileOperationsOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class SigningClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Developer Signing is a service that provides managed artifact signing for all. + + :ivar certificate_profile_operations: CertificateProfileOperationsOperations operations + :vartype certificate_profile_operations: + azure.developer.signing.operations.CertificateProfileOperationsOperations + :param region: The Azure region wherein requests for signing will be sent. Required. + :type region: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-06-15-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, region: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{region}.codesigning.azure.net/" + self._config = SigningClientConfiguration(region=region, 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.certificate_profile_operations = CertificateProfileOperationsOperations( + 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 = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + + 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) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_configuration.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_configuration.py new file mode 100644 index 0000000000000..d70d4fffd3f80 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_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 SigningClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for SigningClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param region: The Azure region wherein requests for signing will be sent. Required. + :type region: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-06-15-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, region: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-06-15-preview") + + if region is None: + raise ValueError("Parameter 'region' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.region = region + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://codesigning.azure.net/.default"]) + kwargs.setdefault("sdk_moniker", "developer-signing/{}".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/developer-signing/azure-developer-signing/azure/developer/signing/_model_base.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_model_base.py new file mode 100644 index 0000000000000..43fd8c7e9b1b4 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_model_base.py @@ -0,0 +1,888 @@ +# 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 copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +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 = 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 _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +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) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + 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()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +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 + + 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 len(annotation.__args__) <= 2: # 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 + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + 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_annotations(annotation.__args__) # pyright: ignore + ] + + 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 + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + 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, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + 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 + visibility: typing.Optional[typing.List[str]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility) diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_patch.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_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/developer-signing/azure-developer-signing/azure/developer/signing/_serialization.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_serialization.py new file mode 100644 index 0000000000000..8139854b97bb8 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_serialization.py @@ -0,0 +1,2000 @@ +# -------------------------------------------------------------------------- +# +# 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 + elif content_type.startswith("text/"): + return data_as_str + 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 or data is CoreNull: + 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/communication/azure-communication-messages/azure/communication/messages/_types.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_version.py similarity index 80% rename from sdk/communication/azure-communication-messages/azure/communication/messages/_types.py rename to sdk/developer-signing/azure-developer-signing/azure/developer/signing/_version.py index c4a9e104060d6..be71c81bd2821 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_types.py +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/_version.py @@ -1,5 +1,4 @@ # 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. @@ -7,5 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from typing import Literal -RepeatabilityResult = Literal["accepted", "rejected"] +VERSION = "1.0.0b1" diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/__init__.py new file mode 100644 index 0000000000000..de169a893b2a1 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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 SigningClient + +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__ = [ + "SigningClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_client.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_client.py new file mode 100644 index 0000000000000..bf34dc64912f4 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_client.py @@ -0,0 +1,109 @@ +# 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 typing_extensions import Self + +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 SigningClientConfiguration +from .operations import CertificateProfileOperationsOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class SigningClient: # pylint: disable=client-accepts-api-version-keyword + """Azure Developer Signing is a service that provides managed artifact signing for all. + + :ivar certificate_profile_operations: CertificateProfileOperationsOperations operations + :vartype certificate_profile_operations: + azure.developer.signing.aio.operations.CertificateProfileOperationsOperations + :param region: The Azure region wherein requests for signing will be sent. Required. + :type region: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-06-15-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, region: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{region}.codesigning.azure.net/" + self._config = SigningClientConfiguration(region=region, 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.certificate_profile_operations = CertificateProfileOperationsOperations( + 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 = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + + 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) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_configuration.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_configuration.py new file mode 100644 index 0000000000000..f2a9cc8efbc6f --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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 SigningClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for SigningClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param region: The Azure region wherein requests for signing will be sent. Required. + :type region: str + :param credential: Credential used to authenticate requests to the service. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-06-15-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, region: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-06-15-preview") + + if region is None: + raise ValueError("Parameter 'region' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.region = region + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://codesigning.azure.net/.default"]) + kwargs.setdefault("sdk_moniker", "developer-signing/{}".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/developer-signing/azure-developer-signing/azure/developer/signing/aio/_patch.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/__init__.py new file mode 100644 index 0000000000000..b7893fe5a32f8 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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 CertificateProfileOperationsOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "CertificateProfileOperationsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/_operations.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/_operations.py new file mode 100644 index 0000000000000..1e7dac5082f5a --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/_operations.py @@ -0,0 +1,635 @@ +# 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, + AsyncIterable, + AsyncIterator, + Callable, + Dict, + IO, + List, + Optional, + Type, + TypeVar, + Union, + cast, + 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.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 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_certificate_profile_operations_get_sign_root_certificate_request, + build_certificate_profile_operations_get_signing_status_request, + build_certificate_profile_operations_list_extended_key_usages_request, + build_certificate_profile_operations_sign_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 CertificateProfileOperationsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.signing.aio.SigningClient`'s + :attr:`certificate_profile_operations` 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_signing_status( # pylint: disable=inconsistent-return-statements + self, account_name: str, certificate_profile: str, operation_id: str, **kwargs: Any + ) -> None: + """Gets the status of a signing operation. + + This status operation requires that a Sign request has been submitted and the operationId is + known. + + :param account_name: Signing account name. Required. + :type account_name: str + :param certificate_profile: Signing Certificate profile name. Required. + :type certificate_profile: str + :param operation_id: The unique ID of the operation. Required. + :type operation_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_certificate_profile_operations_get_signing_status_request( + account_name=account_name, + certificate_profile=certificate_profile, + operation_id=operation_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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 [200]: + 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_sign_root_certificate( + self, account_name: str, certificate_profile: str, **kwargs: Any + ) -> AsyncIterator[bytes]: + """Gets the signing root certificate on the certificate chain for that account and profile name. + + The root certificate is generated as part of the initial account creation and it is used to + sign the bits for the profile provided. + + :param account_name: Signing account name. Required. + :type account_name: str + :param certificate_profile: Signing Certificate profile name. Required. + :type certificate_profile: str + :return: AsyncIterator[bytes] + :rtype: AsyncIterator[bytes] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_certificate_profile_operations_get_sign_root_certificate_request( + account_name=account_name, + certificate_profile=certificate_profile, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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) + raise HttpResponseError(response=response) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_extended_key_usages( + self, account_name: str, certificate_profile: str, **kwargs: Any + ) -> AsyncIterable["_models.ExtendedKeyUsage"]: + """Gets a list of extended key usage object identifiers that are allowed for this account and + profile combination. + + The list of extended key usages are used to determine the purpose of the certificate usage as + part of the signing operation. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :return: An iterator like instance of ExtendedKeyUsage + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.signing.models.ExtendedKeyUsage] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "eku": "str" + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.ExtendedKeyUsage]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_certificate_profile_operations_list_extended_key_usages_request( + account_name=account_name, + certificate_profile=certificate_profile, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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 = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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.ExtendedKeyUsage], 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( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + 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) + + async def _sign_initial( + self, + account_name: str, + certificate_profile: str, + body: Union[_models.SigningPayloadOptions, JSON, IO[bytes]], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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[AsyncIterator[bytes]] = 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_certificate_profile_operations_sign_request( + account_name=account_name, + certificate_profile=certificate_profile, + client_version=client_version, + x_correlation_id=x_correlation_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _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 [202]: + 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["x-ms-error-code"] = self._deserialize("str", response.headers.get("x-ms-error-code")) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: _models.SigningPayloadOptions, + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: ~azure.developer.signing.models.SigningPayloadOptions + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of AsyncLROPoller that returns SignResult. The SignResult is compatible + with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "digest": bytes("bytes", encoding="utf-8"), + "signatureAlgorithm": "str", + "authenticodeHashList": [ + bytes("bytes", encoding="utf-8") + ], + "fileHashList": [ + bytes("bytes", encoding="utf-8") + ] + } + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @overload + async def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: JSON, + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: JSON + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of AsyncLROPoller that returns SignResult. The SignResult is compatible + with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @overload + async def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: IO[bytes], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncLROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: IO[bytes] + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of AsyncLROPoller that returns SignResult. The SignResult is compatible + with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @distributed_trace_async + async def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: Union[_models.SigningPayloadOptions, JSON, IO[bytes]], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + **kwargs: Any + ) -> AsyncLROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Is one of the following types: SigningPayloadOptions, JSON, + IO[bytes] Required. + :type body: ~azure.developer.signing.models.SigningPayloadOptions or JSON or IO[bytes] + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_id: str + :return: An instance of AsyncLROPoller that returns SignResult. The SignResult is compatible + with MutableMapping + :rtype: ~azure.core.polling.AsyncLROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "digest": bytes("bytes", encoding="utf-8"), + "signatureAlgorithm": "str", + "authenticodeHashList": [ + bytes("bytes", encoding="utf-8") + ], + "fileHashList": [ + bytes("bytes", encoding="utf-8") + ] + } + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + _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.SignResult] = 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._sign_initial( + account_name=account_name, + certificate_profile=certificate_profile, + body=body, + client_version=client_version, + x_correlation_id=x_correlation_id, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore + 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["x-ms-error-code"] = self._deserialize("str", response.headers.get("x-ms-error-code")) + + deserialized = _deserialize(_models.SignResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + + 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.SignResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[_models.SignResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/_patch.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/aio/operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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/developer-signing/azure-developer-signing/azure/developer/signing/models/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/__init__.py new file mode 100644 index 0000000000000..65c9844cd54ac --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/__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 ._models import ExtendedKeyUsage +from ._models import SignResult +from ._models import SigningPayloadOptions + +from ._enums import SignatureAlgorithm +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ExtendedKeyUsage", + "SignResult", + "SigningPayloadOptions", + "SignatureAlgorithm", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_enums.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_enums.py new file mode 100644 index 0000000000000..a0634a838272a --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_enums.py @@ -0,0 +1,35 @@ +# 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 SignatureAlgorithm(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Algorithms supported for signing.""" + + RS256 = "RS256" + """RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm.""" + RS384 = "RS384" + """RSASSA-PKCS1-v1_5 using SHA-384 hash algorithm.""" + RS512 = "RS512" + """RSASSA-PKCS1-v1_5 using SHA-512 hash algorithm.""" + PS256 = "PS256" + """RSASSA-PSS using SHA-256 hash algorithm.""" + PS384 = "PS384" + """RSASSA-PSS using SHA-384 hash algorithm.""" + PS512 = "PS512" + """RSASSA-PSS using SHA-512 hash algorithm.""" + ES256 = "ES256" + """ECDSA using P-256 and SHA-256 hash algorithm.""" + ES384 = "ES384" + """ECDSA using P-384 and SHA-384 hash algorithm.""" + ES512 = "ES512" + """ECDSA using P-521 and SHA-512 hash algorithm.""" + ES256K = "ES256K" + """ECDSA using secp256k1 and SHA-256 hash algorithm.""" diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_models.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_models.py new file mode 100644 index 0000000000000..948674257ded6 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_models.py @@ -0,0 +1,116 @@ +# 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, 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 ExtendedKeyUsage(_model_base.Model): + """Extended key usage object identifier that are allowable. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + + :ivar eku: An oid string that represents an eku. Required. + :vartype eku: str + """ + + eku: str = rest_field(visibility=["read"]) + """An oid string that represents an eku. Required.""" + + +class SigningPayloadOptions(_model_base.Model): + """The artifact request information to be signed by the service. + + All required parameters must be populated in order to send to server. + + :ivar signature_algorithm: The supported signature algorithm identifiers. Required. Known + values are: "RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", "ES512", + and "ES256K". + :vartype signature_algorithm: str or ~azure.developer.signing.models.SignatureAlgorithm + :ivar digest: Content digest to sign. Required. + :vartype digest: bytes + :ivar file_hash_list: List of full file digital signatures. + :vartype file_hash_list: list[bytes] + :ivar authenticode_hash_list: List of authenticode digital signatures. + :vartype authenticode_hash_list: list[bytes] + """ + + signature_algorithm: Union[str, "_models.SignatureAlgorithm"] = rest_field(name="signatureAlgorithm") + """The supported signature algorithm identifiers. Required. Known values are: \"RS256\", + \"RS384\", \"RS512\", \"PS256\", \"PS384\", \"PS512\", \"ES256\", \"ES384\", \"ES512\", and + \"ES256K\".""" + digest: bytes = rest_field(format="base64") + """Content digest to sign. Required.""" + file_hash_list: Optional[List[bytes]] = rest_field(name="fileHashList", format="base64") + """List of full file digital signatures.""" + authenticode_hash_list: Optional[List[bytes]] = rest_field(name="authenticodeHashList", format="base64") + """List of authenticode digital signatures.""" + + @overload + def __init__( + self, + *, + signature_algorithm: Union[str, "_models.SignatureAlgorithm"], + digest: bytes, + file_hash_list: Optional[List[bytes]] = None, + authenticode_hash_list: Optional[List[bytes]] = 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 SignResult(_model_base.Model): + """The sign status model. + + :ivar signature: Digital signature of the requested content digest. + :vartype signature: bytes + :ivar signing_certificate: Signing certificate corresponding to the private key used to sign + the requested + digest. + :vartype signing_certificate: bytes + """ + + signature: Optional[bytes] = rest_field(format="base64") + """Digital signature of the requested content digest.""" + signing_certificate: Optional[bytes] = rest_field(name="signingCertificate", format="base64") + """Signing certificate corresponding to the private key used to sign the requested + digest.""" + + @overload + def __init__( + self, + *, + signature: Optional[bytes] = None, + signing_certificate: Optional[bytes] = 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/developer-signing/azure-developer-signing/azure/developer/signing/models/_patch.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/models/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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/developer-signing/azure-developer-signing/azure/developer/signing/operations/__init__.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/__init__.py new file mode 100644 index 0000000000000..b7893fe5a32f8 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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 CertificateProfileOperationsOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "CertificateProfileOperationsOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/_operations.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/_operations.py new file mode 100644 index 0000000000000..9ea159d82dce7 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/_operations.py @@ -0,0 +1,735 @@ +# 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, Iterable, Iterator, List, Optional, Type, TypeVar, Union, cast, 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.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 + +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_certificate_profile_operations_get_signing_status_request( # pylint: disable=name-too-long + account_name: str, certificate_profile: str, operation_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-06-15-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/{operationId}" + path_format_arguments = { + "accountName": _SERIALIZER.url("account_name", account_name, "str"), + "certificateProfile": _SERIALIZER.url("certificate_profile", certificate_profile, "str"), + "operationId": _SERIALIZER.url("operation_id", operation_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_certificate_profile_operations_get_sign_root_certificate_request( # pylint: disable=name-too-long + account_name: str, certificate_profile: 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-06-15-preview")) + accept = _headers.pop("Accept", "application/x-x509-ca-cert") + + # Construct URL + _url = "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/rootcert" + path_format_arguments = { + "accountName": _SERIALIZER.url("account_name", account_name, "str"), + "certificateProfile": _SERIALIZER.url("certificate_profile", certificate_profile, "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_certificate_profile_operations_list_extended_key_usages_request( # pylint: disable=name-too-long + account_name: str, certificate_profile: 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-06-15-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}/sign/eku" + path_format_arguments = { + "accountName": _SERIALIZER.url("account_name", account_name, "str"), + "certificateProfile": _SERIALIZER.url("certificate_profile", certificate_profile, "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_certificate_profile_operations_sign_request( # pylint: disable=name-too-long + account_name: str, + certificate_profile: str, + *, + client_version: Optional[str] = None, + x_correlation_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-06-15-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/codesigningaccounts/{accountName}/certificateprofiles/{certificateProfile}:sign" + path_format_arguments = { + "accountName": _SERIALIZER.url("account_name", account_name, "str"), + "certificateProfile": _SERIALIZER.url("certificate_profile", certificate_profile, "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 client_version is not None: + _headers["client-version"] = _SERIALIZER.header("client_version", client_version, "str") + if x_correlation_id is not None: + _headers["x-correlation-id"] = _SERIALIZER.header("x_correlation_id", x_correlation_id, "str") + 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, params=_params, headers=_headers, **kwargs) + + +class CertificateProfileOperationsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.signing.SigningClient`'s + :attr:`certificate_profile_operations` 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_signing_status( # pylint: disable=inconsistent-return-statements + self, account_name: str, certificate_profile: str, operation_id: str, **kwargs: Any + ) -> None: + """Gets the status of a signing operation. + + This status operation requires that a Sign request has been submitted and the operationId is + known. + + :param account_name: Signing account name. Required. + :type account_name: str + :param certificate_profile: Signing Certificate profile name. Required. + :type certificate_profile: str + :param operation_id: The unique ID of the operation. Required. + :type operation_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_certificate_profile_operations_get_signing_status_request( + account_name=account_name, + certificate_profile=certificate_profile, + operation_id=operation_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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 [200]: + 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_sign_root_certificate(self, account_name: str, certificate_profile: str, **kwargs: Any) -> Iterator[bytes]: + """Gets the signing root certificate on the certificate chain for that account and profile name. + + The root certificate is generated as part of the initial account creation and it is used to + sign the bits for the profile provided. + + :param account_name: Signing account name. Required. + :type account_name: str + :param certificate_profile: Signing Certificate profile name. Required. + :type certificate_profile: str + :return: Iterator[bytes] + :rtype: Iterator[bytes] + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_certificate_profile_operations_get_sign_root_certificate_request( + account_name=account_name, + certificate_profile=certificate_profile, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_extended_key_usages( + self, account_name: str, certificate_profile: str, **kwargs: Any + ) -> Iterable["_models.ExtendedKeyUsage"]: + """Gets a list of extended key usage object identifiers that are allowed for this account and + profile combination. + + The list of extended key usages are used to determine the purpose of the certificate usage as + part of the signing operation. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :return: An iterator like instance of ExtendedKeyUsage + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.signing.models.ExtendedKeyUsage] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "eku": "str" + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.ExtendedKeyUsage]] = kwargs.pop("cls", None) + + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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_certificate_profile_operations_list_extended_key_usages_request( + account_name=account_name, + certificate_profile=certificate_profile, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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 = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _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.ExtendedKeyUsage], 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]: + 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) + + def _sign_initial( + self, + account_name: str, + certificate_profile: str, + body: Union[_models.SigningPayloadOptions, JSON, IO[bytes]], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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[Iterator[bytes]] = 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_certificate_profile_operations_sign_request( + account_name=account_name, + certificate_profile=certificate_profile, + client_version=client_version, + x_correlation_id=x_correlation_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _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 [202]: + 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["x-ms-error-code"] = self._deserialize("str", response.headers.get("x-ms-error-code")) + + deserialized = response.iter_bytes() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: _models.SigningPayloadOptions, + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: ~azure.developer.signing.models.SigningPayloadOptions + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of LROPoller that returns SignResult. The SignResult is compatible with + MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "digest": bytes("bytes", encoding="utf-8"), + "signatureAlgorithm": "str", + "authenticodeHashList": [ + bytes("bytes", encoding="utf-8") + ], + "fileHashList": [ + bytes("bytes", encoding="utf-8") + ] + } + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @overload + def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: JSON, + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: JSON + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of LROPoller that returns SignResult. The SignResult is compatible with + MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @overload + def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: IO[bytes], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> LROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Required. + :type body: IO[bytes] + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_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: An instance of LROPoller that returns SignResult. The SignResult is compatible with + MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + + @distributed_trace + def begin_sign( + self, + account_name: str, + certificate_profile: str, + body: Union[_models.SigningPayloadOptions, JSON, IO[bytes]], + *, + client_version: Optional[str] = None, + x_correlation_id: Optional[str] = None, + **kwargs: Any + ) -> LROPoller[_models.SignResult]: + """Submit a sign operation. + + Submit a sign operation under the created account and profile name provided. + + :param account_name: Azure Developer Signing account name. Required. + :type account_name: str + :param certificate_profile: Azure Developer Signing certificate profile name under an account. + Required. + :type certificate_profile: str + :param body: Body parameter. Is one of the following types: SigningPayloadOptions, JSON, + IO[bytes] Required. + :type body: ~azure.developer.signing.models.SigningPayloadOptions or JSON or IO[bytes] + :keyword client_version: An optional client version. Default value is None. + :paramtype client_version: str + :keyword x_correlation_id: An identifier used to batch multiple requests. Default value is + None. + :paramtype x_correlation_id: str + :return: An instance of LROPoller that returns SignResult. The SignResult is compatible with + MutableMapping + :rtype: ~azure.core.polling.LROPoller[~azure.developer.signing.models.SignResult] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "digest": bytes("bytes", encoding="utf-8"), + "signatureAlgorithm": "str", + "authenticodeHashList": [ + bytes("bytes", encoding="utf-8") + ], + "fileHashList": [ + bytes("bytes", encoding="utf-8") + ] + } + + # response body for status code(s): 202 + response == { + "signature": bytes("bytes", encoding="utf-8"), + "signingCertificate": bytes("bytes", encoding="utf-8") + } + """ + _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.SignResult] = 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._sign_initial( + account_name=account_name, + certificate_profile=certificate_profile, + body=body, + client_version=client_version, + x_correlation_id=x_correlation_id, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore + 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["x-ms-error-code"] = self._deserialize("str", response.headers.get("x-ms-error-code")) + + deserialized = _deserialize(_models.SignResult, response.json().get("result")) + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + return deserialized + + path_format_arguments = { + "region": self._serialize.url("self._config.region", self._config.region, "str"), + } + + 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.SignResult].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[_models.SignResult]( + self._client, raw_result, get_long_running_output, polling_method # type: ignore + ) diff --git a/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/_patch.py b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/operations/_patch.py new file mode 100644 index 0000000000000..f7dd32510333d --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/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/developer-signing/azure-developer-signing/azure/developer/signing/py.typed b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/py.typed new file mode 100644 index 0000000000000..e5aff4f83af86 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/azure/developer/signing/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/developer-signing/azure-developer-signing/dev_requirements.txt b/sdk/developer-signing/azure-developer-signing/dev_requirements.txt new file mode 100644 index 0000000000000..c82827bb56f44 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/dev_requirements.txt @@ -0,0 +1,4 @@ +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp \ No newline at end of file diff --git a/sdk/developer-signing/azure-developer-signing/sdk_packaging.toml b/sdk/developer-signing/azure-developer-signing/sdk_packaging.toml new file mode 100644 index 0000000000000..e7687fdae93bc --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/sdk_packaging.toml @@ -0,0 +1,2 @@ +[packaging] +auto_update = false \ No newline at end of file diff --git a/sdk/developer-signing/azure-developer-signing/setup.py b/sdk/developer-signing/azure-developer-signing/setup.py new file mode 100644 index 0000000000000..a3fbcfa600019 --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/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-developer-signing" +PACKAGE_PPRINT_NAME = "Azure Developer Signing" + +# 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.developer", + ] + ), + include_package_data=True, + package_data={ + "azure.developer.signing": ["py.typed"], + }, + install_requires=[ + "isodate>=0.6.1", + "azure-core>=1.30.0", + "typing-extensions>=4.6.0", + ], + python_requires=">=3.8", +) diff --git a/sdk/developer-signing/azure-developer-signing/tsp-location.yaml b/sdk/developer-signing/azure-developer-signing/tsp-location.yaml new file mode 100644 index 0000000000000..236804ec8a3de --- /dev/null +++ b/sdk/developer-signing/azure-developer-signing/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/developersigning/DeveloperSigning +commit: 228acac22c34fa19cd629ba2df005822ab8ba959 +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/developer-signing/ci.yml b/sdk/developer-signing/ci.yml new file mode 100644 index 0000000000000..94a3a5534b5c8 --- /dev/null +++ b/sdk/developer-signing/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/developer-signing/ + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + - restapi* + paths: + include: + - sdk/developer-signing/ + +extends: + template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml + parameters: + ServiceDirectory: developer-signing + TestProxy: true + Artifacts: + - name: azure-developer-signing + safeName: azuredevelopersigning diff --git a/sdk/face/azure-ai-vision-face/_meta.json b/sdk/face/azure-ai-vision-face/_meta.json index ebf0ddcdb2f03..d7c58f90f0dba 100644 --- a/sdk/face/azure-ai-vision-face/_meta.json +++ b/sdk/face/azure-ai-vision-face/_meta.json @@ -1,7 +1,7 @@ { - "commit": "37acfe2967e5e1be1169146ac461eb1875c9476e", + "commit": "228acac22c34fa19cd629ba2df005822ab8ba959", "repository_url": "https://github.com/Azure/azure-rest-api-specs", "typespec_src": "specification/ai/Face", - "@azure-tools/typespec-python": "0.23.8", - "@autorest/python": "6.13.15" + "@azure-tools/typespec-python": "0.24.3", + "@autorest/python": "6.14.3" } \ No newline at end of file diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/__init__.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/__init__.py index 3b5d75d6c9f2b..7e4a033b7ec62 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/__init__.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/__init__.py @@ -6,19 +6,23 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import FaceClient -from ._patch import FaceSessionClient +from ._client import FaceClient +from ._client import FaceSessionClient 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__ = [ "FaceClient", "FaceSessionClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_client.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_client.py index 321b3f0a8b79f..a62711f626afd 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_client.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, TYPE_CHECKING, Union +from typing_extensions import Self from azure.core import PipelineClient from azure.core.credentials import AzureKeyCredential @@ -94,7 +95,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "FaceClient": + def __enter__(self) -> Self: self._client.__enter__() return self @@ -173,7 +174,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "FaceSessionClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_model_base.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_model_base.py index 5cf70733404de..43fd8c7e9b1b4 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_model_base.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_model_base.py @@ -883,5 +883,6 @@ def rest_discriminator( *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, ) -> typing.Any: - return _RestField(name=name, type=type, is_discriminator=True) + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility) diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_operations/_operations.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_operations/_operations.py index 2744deda0070b..8ec59de05bd7d 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_operations/_operations.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_operations/_operations.py @@ -489,16 +489,18 @@ def _detect_from_url( face_id_time_to_live: Optional[int] = None, **kwargs: Any, ) -> List[_models.FaceDetectionResult]: - # pylint: disable=line-too-long """Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. .. [!IMPORTANT] - To mitigate potential misuse that can subject people to stereotyping, discrimination, or - unfair denial of services, we are retiring Face API attributes that predict emotion, gender, - age, smile, facial hair, hair, and makeup. Read more about this decision + Microsoft has retired or restricted facial recognition capabilities that can be used to try + to infer emotional states and identity attributes which, if misused, can subject people to + stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion + and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email + Azure Face API azureface@microsoft.com if you have a responsible use case that would benefit + from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. @@ -582,284 +584,183 @@ def _detect_from_url( # JSON input template you can fill out and use as your body input. body = { - "url": "str" # URL of input image. Required. + "url": "str" } # response body for status code(s): 200 response == [ { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, "faceAttributes": { "accessories": [ { - "confidence": 0.0, # Confidence level of the - accessory type. Range between [0,1]. Required. - "type": "str" # Type of the accessory. - Required. Known values are: "headwear", "glasses", and "mask". + "confidence": 0.0, + "type": "str" } ], - "age": 0.0, # Optional. Age in years. + "age": 0.0, "blur": { - "blurLevel": "str", # An enum value indicating level - of blurriness. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of - blurriness ranging from 0 to 1. Required. + "blurLevel": "str", + "value": 0.0 }, "exposure": { - "exposureLevel": "str", # An enum value indicating - level of exposure. Required. Known values are: "underExposure", - "goodExposure", and "overExposure". - "value": 0.0 # A number indicating level of exposure - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. Required. + "exposureLevel": "str", + "value": 0.0 }, "facialHair": { - "beard": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "moustache": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "sideburns": 0.0 # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - }, - "glasses": "str", # Optional. Glasses type if any of the - face. Known values are: "noGlasses", "readingGlasses", "sunglasses", and - "swimmingGoggles". + "beard": 0.0, + "moustache": 0.0, + "sideburns": 0.0 + }, + "glasses": "str", "hair": { - "bald": 0.0, # A number describing confidence level - of whether the person is bald. Required. + "bald": 0.0, "hairColor": [ { - "color": "str", # Name of the hair - color. Required. Known values are: "unknown", "white", - "gray", "blond", "brown", "red", "black", and "other". - "confidence": 0.0 # Confidence level - of the color. Range between [0,1]. Required. + "color": "str", + "confidence": 0.0 } ], - "invisible": bool # A boolean value describing - whether the hair is visible in the image. Required. + "invisible": bool }, "headPose": { - "pitch": 0.0, # Value of angles. Required. - "roll": 0.0, # Value of angles. Required. - "yaw": 0.0 # Value of angles. Required. + "pitch": 0.0, + "roll": 0.0, + "yaw": 0.0 }, "mask": { - "noseAndMouthCovered": bool, # A boolean value - indicating whether nose and mouth are covered. Required. - "type": "str" # Type of the mask. Required. Known - values are: "faceMask", "noMask", "otherMaskOrOcclusion", and - "uncertain". + "noseAndMouthCovered": bool, + "type": "str" }, "noise": { - "noiseLevel": "str", # An enum value indicating - level of noise. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of noise - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. [0, 0.3) is low noise - level. [0.3, 0.7) is medium noise level. [0.7, 1] is high noise - level. Required. + "noiseLevel": "str", + "value": 0.0 }, "occlusion": { - "eyeOccluded": bool, # A boolean value indicating - whether eyes are occluded. Required. - "foreheadOccluded": bool, # A boolean value - indicating whether forehead is occluded. Required. - "mouthOccluded": bool # A boolean value indicating - whether the mouth is occluded. Required. - }, - "qualityForRecognition": "str", # Optional. Properties - describing the overall image quality regarding whether the image being - used in the detection is of sufficient quality to attempt face - recognition on. Known values are: "low", "medium", and "high". - "smile": 0.0 # Optional. Smile intensity, a number between - [0,1]. + "eyeOccluded": bool, + "foreheadOccluded": bool, + "mouthOccluded": bool + }, + "qualityForRecognition": "str", + "smile": 0.0 }, - "faceId": "str", # Optional. Unique faceId of the detected face, - created by detection API and it will expire 24 hours after the detection - call. To return this, it requires 'returnFaceId' parameter to be true. + "faceId": "str", "faceLandmarks": { "eyeLeftBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 } }, - "recognitionModel": "str" # Optional. The 'recognitionModel' - associated with this faceId. This is only returned when - 'returnRecognitionModel' is explicitly set as true. Known values are: - "recognition_01", "recognition_02", "recognition_03", and "recognition_04". + "recognitionModel": "str" } ] """ @@ -946,16 +847,18 @@ def _detect( face_id_time_to_live: Optional[int] = None, **kwargs: Any, ) -> List[_models.FaceDetectionResult]: - # pylint: disable=line-too-long """Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. .. [!IMPORTANT] - To mitigate potential misuse that can subject people to stereotyping, discrimination, or - unfair denial of services, we are retiring Face API attributes that predict emotion, gender, - age, smile, facial hair, hair, and makeup. Read more about this decision + Microsoft has retired or restricted facial recognition capabilities that can be used to try + to infer emotional states and identity attributes which, if misused, can subject people to + stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion + and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email + Azure Face API azureface@microsoft.com if you have a responsible use case that would benefit + from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. @@ -1039,277 +942,176 @@ def _detect( response == [ { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, "faceAttributes": { "accessories": [ { - "confidence": 0.0, # Confidence level of the - accessory type. Range between [0,1]. Required. - "type": "str" # Type of the accessory. - Required. Known values are: "headwear", "glasses", and "mask". + "confidence": 0.0, + "type": "str" } ], - "age": 0.0, # Optional. Age in years. + "age": 0.0, "blur": { - "blurLevel": "str", # An enum value indicating level - of blurriness. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of - blurriness ranging from 0 to 1. Required. + "blurLevel": "str", + "value": 0.0 }, "exposure": { - "exposureLevel": "str", # An enum value indicating - level of exposure. Required. Known values are: "underExposure", - "goodExposure", and "overExposure". - "value": 0.0 # A number indicating level of exposure - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. Required. + "exposureLevel": "str", + "value": 0.0 }, "facialHair": { - "beard": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "moustache": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "sideburns": 0.0 # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - }, - "glasses": "str", # Optional. Glasses type if any of the - face. Known values are: "noGlasses", "readingGlasses", "sunglasses", and - "swimmingGoggles". + "beard": 0.0, + "moustache": 0.0, + "sideburns": 0.0 + }, + "glasses": "str", "hair": { - "bald": 0.0, # A number describing confidence level - of whether the person is bald. Required. + "bald": 0.0, "hairColor": [ { - "color": "str", # Name of the hair - color. Required. Known values are: "unknown", "white", - "gray", "blond", "brown", "red", "black", and "other". - "confidence": 0.0 # Confidence level - of the color. Range between [0,1]. Required. + "color": "str", + "confidence": 0.0 } ], - "invisible": bool # A boolean value describing - whether the hair is visible in the image. Required. + "invisible": bool }, "headPose": { - "pitch": 0.0, # Value of angles. Required. - "roll": 0.0, # Value of angles. Required. - "yaw": 0.0 # Value of angles. Required. + "pitch": 0.0, + "roll": 0.0, + "yaw": 0.0 }, "mask": { - "noseAndMouthCovered": bool, # A boolean value - indicating whether nose and mouth are covered. Required. - "type": "str" # Type of the mask. Required. Known - values are: "faceMask", "noMask", "otherMaskOrOcclusion", and - "uncertain". + "noseAndMouthCovered": bool, + "type": "str" }, "noise": { - "noiseLevel": "str", # An enum value indicating - level of noise. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of noise - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. [0, 0.3) is low noise - level. [0.3, 0.7) is medium noise level. [0.7, 1] is high noise - level. Required. + "noiseLevel": "str", + "value": 0.0 }, "occlusion": { - "eyeOccluded": bool, # A boolean value indicating - whether eyes are occluded. Required. - "foreheadOccluded": bool, # A boolean value - indicating whether forehead is occluded. Required. - "mouthOccluded": bool # A boolean value indicating - whether the mouth is occluded. Required. - }, - "qualityForRecognition": "str", # Optional. Properties - describing the overall image quality regarding whether the image being - used in the detection is of sufficient quality to attempt face - recognition on. Known values are: "low", "medium", and "high". - "smile": 0.0 # Optional. Smile intensity, a number between - [0,1]. + "eyeOccluded": bool, + "foreheadOccluded": bool, + "mouthOccluded": bool + }, + "qualityForRecognition": "str", + "smile": 0.0 }, - "faceId": "str", # Optional. Unique faceId of the detected face, - created by detection API and it will expire 24 hours after the detection - call. To return this, it requires 'returnFaceId' parameter to be true. + "faceId": "str", "faceLandmarks": { "eyeLeftBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 } }, - "recognitionModel": "str" # Optional. The 'recognitionModel' - associated with this faceId. This is only returned when - 'returnRecognitionModel' is explicitly set as true. Known values are: - "recognition_01", "recognition_02", "recognition_03", and "recognition_04". + "recognitionModel": "str" } ] """ @@ -1376,7 +1178,6 @@ def _detect( def find_similar( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1407,32 +1208,20 @@ def find_similar( # JSON input template you can fill out and use as your body input. body = { - "faceId": "str", # faceId of the query face. User needs to call "Detect" - first to get a valid faceId. Note that this faceId is not persisted and will - expire 24 hours after the detection call. Required. + "faceId": "str", "faceIds": [ - "str" # An array of candidate faceIds. All of them are created by - "Detect" and the faceIds will expire 24 hours after the detection call. The - number of faceIds is limited to 1000. Required. + "str" ], - "maxNumOfCandidatesReturned": 0, # Optional. The number of top similar faces - returned. The valid range is [1, 1000]. Default value is 20. - "mode": "str" # Optional. Similar face searching mode. It can be - 'matchPerson' or 'matchFace'. Default value is 'matchPerson'. Known values are: - "matchPerson" and "matchFace". + "maxNumOfCandidatesReturned": 0, + "mode": "str" } # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1448,7 +1237,6 @@ def find_similar( mode: Optional[Union[str, _models.FindSimilarMatchMode]] = None, **kwargs: Any, ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1492,14 +1280,9 @@ def find_similar( # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1508,7 +1291,6 @@ def find_similar( def find_similar( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1540,14 +1322,9 @@ def find_similar( # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1563,7 +1340,6 @@ def find_similar( mode: Optional[Union[str, _models.FindSimilarMatchMode]] = None, **kwargs: Any, ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1605,32 +1381,20 @@ def find_similar( # JSON input template you can fill out and use as your body input. body = { - "faceId": "str", # faceId of the query face. User needs to call "Detect" - first to get a valid faceId. Note that this faceId is not persisted and will - expire 24 hours after the detection call. Required. + "faceId": "str", "faceIds": [ - "str" # An array of candidate faceIds. All of them are created by - "Detect" and the faceIds will expire 24 hours after the detection call. The - number of faceIds is limited to 1000. Required. + "str" ], - "maxNumOfCandidatesReturned": 0, # Optional. The number of top similar faces - returned. The valid range is [1, 1000]. Default value is 20. - "mode": "str" # Optional. Similar face searching mode. It can be - 'matchPerson' or 'matchFace'. Default value is 'matchPerson'. Known values are: - "matchPerson" and "matchFace". + "maxNumOfCandidatesReturned": 0, + "mode": "str" } # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1654,9 +1418,9 @@ def find_similar( if face_ids is _Unset: raise TypeError("missing required argument: face_ids") body = { - "faceid": face_id, - "faceids": face_ids, - "maxnumofcandidatesreturned": max_num_of_candidates_returned, + "faceId": face_id, + "faceIds": face_ids, + "maxNumOfCandidatesReturned": max_num_of_candidates_returned, "mode": mode, } body = {k: v for k, v in body.items() if v is not None} @@ -1707,7 +1471,6 @@ def find_similar( def verify_face_to_face( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1737,19 +1500,14 @@ def verify_face_to_face( # JSON input template you can fill out and use as your body input. body = { - "faceId1": "str", # The faceId of one face, come from "Detect". Required. - "faceId2": "str" # The faceId of another face, come from "Detect". Required. + "faceId1": "str", + "faceId2": "str" } # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1757,7 +1515,6 @@ def verify_face_to_face( def verify_face_to_face( self, *, face_id1: str, face_id2: str, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1789,13 +1546,8 @@ def verify_face_to_face( # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1803,7 +1555,6 @@ def verify_face_to_face( def verify_face_to_face( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1833,13 +1584,8 @@ def verify_face_to_face( # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1847,7 +1593,6 @@ def verify_face_to_face( def verify_face_to_face( self, body: Union[JSON, IO[bytes]] = _Unset, *, face_id1: str = _Unset, face_id2: str = _Unset, **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1878,19 +1623,14 @@ def verify_face_to_face( # JSON input template you can fill out and use as your body input. body = { - "faceId1": "str", # The faceId of one face, come from "Detect". Required. - "faceId2": "str" # The faceId of another face, come from "Detect". Required. + "faceId1": "str", + "faceId2": "str" } # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -1912,7 +1652,7 @@ def verify_face_to_face( raise TypeError("missing required argument: face_id1") if face_id2 is _Unset: raise TypeError("missing required argument: face_id2") - body = {"faceid1": face_id1, "faceid2": face_id2} + body = {"faceId1": face_id1, "faceId2": face_id2} body = {k: v for k, v in body.items() if v is not None} content_type = content_type or "application/json" _content = None @@ -1959,7 +1699,6 @@ def verify_face_to_face( @overload def group(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -1992,8 +1731,7 @@ def group(self, body: JSON, *, content_type: str = "application/json", **kwargs: # JSON input template you can fill out and use as your body input. body = { "faceIds": [ - "str" # Array of candidate faceIds created by "Detect". The maximum - is 1000 faces. Required. + "str" ] } @@ -2001,13 +1739,11 @@ def group(self, body: JSON, *, content_type: str = "application/json", **kwargs: response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -2016,7 +1752,6 @@ def group(self, body: JSON, *, content_type: str = "application/json", **kwargs: def group( self, *, face_ids: List[str], content_type: str = "application/json", **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -2051,13 +1786,11 @@ def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -2066,7 +1799,6 @@ def group( def group( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -2100,13 +1832,11 @@ def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -2115,7 +1845,6 @@ def group( def group( self, body: Union[JSON, IO[bytes]] = _Unset, *, face_ids: List[str] = _Unset, **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -2148,8 +1877,7 @@ def group( # JSON input template you can fill out and use as your body input. body = { "faceIds": [ - "str" # Array of candidate faceIds created by "Detect". The maximum - is 1000 faces. Required. + "str" ] } @@ -2157,13 +1885,11 @@ def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -2184,7 +1910,7 @@ def group( if body is _Unset: if face_ids is _Unset: raise TypeError("missing required argument: face_ids") - body = {"faceids": face_ids} + body = {"faceIds": face_ids} body = {k: v for k, v in body.items() if v is not None} content_type = content_type or "application/json" _content = None @@ -2236,7 +1962,6 @@ class FaceSessionClientOperationsMixin(FaceSessionClientMixinABC): def create_liveness_session( self, body: _models.CreateLivenessSessionContent, *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2259,7 +1984,7 @@ def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -2274,33 +1999,17 @@ def create_liveness_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -2308,7 +2017,6 @@ def create_liveness_session( def create_liveness_session( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2331,7 +2039,7 @@ def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -2346,13 +2054,8 @@ def create_liveness_session( # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -2360,7 +2063,6 @@ def create_liveness_session( def create_liveness_session( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2383,7 +2085,7 @@ def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -2398,13 +2100,8 @@ def create_liveness_session( # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -2412,7 +2109,6 @@ def create_liveness_session( def create_liveness_session( self, body: Union[_models.CreateLivenessSessionContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2435,8 +2131,8 @@ def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Is one of the following types: CreateLivenessSessionContent, JSON, IO[bytes] - Required. + :param body: Body parameter. Is one of the following types: CreateLivenessSessionContent, JSON, + IO[bytes] Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent or JSON or IO[bytes] :return: CreateLivenessSessionResult. The CreateLivenessSessionResult is compatible with MutableMapping @@ -2448,33 +2144,17 @@ def create_liveness_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -2586,8 +2266,6 @@ def delete_liveness_session( # pylint: disable=inconsistent-return-statements 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.FaceErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) @@ -2597,7 +2275,6 @@ def delete_liveness_session( # pylint: disable=inconsistent-return-statements @distributed_trace def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _models.LivenessSession: - # pylint: disable=line-too-long """Get session result of detectLiveness/singleModal call. :param session_id: The unique ID to reference this session. Required. @@ -2611,114 +2288,60 @@ def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _models # response body for status code(s): 200 response == { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this session was - created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. Required. - "status": "str", # The current status of the session. Required. Known values - are: "NotStarted", "Started", and "ResultAvailable". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "status": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", "result": { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" }, - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime when this - session was started by the client. + "sessionStartDateTime": "2020-02-20 00:00:00" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -2773,7 +2396,6 @@ def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _models def get_liveness_sessions( self, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionItem]: - # pylint: disable=line-too-long """Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. @@ -2796,19 +2418,12 @@ def get_liveness_sessions( # response body for status code(s): 200 response == [ { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this - session was created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. - Required. - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime - when this session was started by the client. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "sessionStartDateTime": "2020-02-20 00:00:00" } ] """ @@ -2865,7 +2480,6 @@ def get_liveness_sessions( def get_liveness_session_audit_entries( self, session_id: str, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionAuditEntry]: - # pylint: disable=line-too-long """Gets session requests and response body for the session. :param session_id: The unique ID to reference this session. Required. @@ -2886,98 +2500,51 @@ def get_liveness_session_audit_entries( # response body for status code(s): 200 response == [ { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" } ] """ @@ -3048,7 +2615,6 @@ def _create_liveness_with_verify_session( def _create_liveness_with_verify_session( self, body: Union[_models.CreateLivenessSessionContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.CreateLivenessWithVerifySessionResult: - # pylint: disable=line-too-long """Create a new liveness session with verify. Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. @@ -3088,8 +2654,8 @@ def _create_liveness_with_verify_session( Extra measures should be taken to validate that the client is sending the expected VerifyImage. - :param body: Is one of the following types: CreateLivenessSessionContent, JSON, IO[bytes] - Required. + :param body: Body parameter. Is one of the following types: CreateLivenessSessionContent, JSON, + IO[bytes] Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent or JSON or IO[bytes] :return: CreateLivenessWithVerifySessionResult. The CreateLivenessWithVerifySessionResult is compatible with MutableMapping @@ -3101,46 +2667,25 @@ def _create_liveness_with_verify_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str", # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str", "verifyImage": { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # Quality of face image for - recognition. Required. Known values are: "low", "medium", and "high". + "qualityForRecognition": "str" } } """ @@ -3214,7 +2759,6 @@ def _create_liveness_with_verify_session_with_verify_image( # pylint: disable=n def _create_liveness_with_verify_session_with_verify_image( # pylint: disable=name-too-long self, body: Union[_models._models.CreateLivenessWithVerifySessionContent, JSON], **kwargs: Any ) -> _models.CreateLivenessWithVerifySessionResult: - # pylint: disable=line-too-long """Create a new liveness session with verify. Provide the verify image during session creation. A session is best for client device scenarios where developers want to authorize a client @@ -3259,49 +2803,27 @@ def _create_liveness_with_verify_session_with_verify_image( # pylint: disable=n # JSON input template you can fill out and use as your body input. body = { "Parameters": { - "livenessOperationMode": "str", # Type of liveness mode the client - should follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not - to allow client to set their own 'deviceCorrelationId' via the Vision SDK. - Default is false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a - '200 - Success' response body to be sent to the client, which may be - undesirable for security reasons. Default is false, clients will receive a - '204 - NoContent' empty body response. Regardless of selection, calling - Session GetResult will always contain a response body enabling business logic - to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool }, "VerifyImage": filetype } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str", # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str", "verifyImage": { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # Quality of face image for - recognition. Required. Known values are: "low", "medium", and "high". + "qualityForRecognition": "str" } } """ @@ -3411,8 +2933,6 @@ def delete_liveness_with_verify_session( # pylint: disable=inconsistent-return- 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.FaceErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) @@ -3424,7 +2944,6 @@ def delete_liveness_with_verify_session( # pylint: disable=inconsistent-return- def get_liveness_with_verify_session_result( self, session_id: str, **kwargs: Any ) -> _models.LivenessWithVerifySession: - # pylint: disable=line-too-long """Get session result of detectLivenessWithVerify/singleModal call. :param session_id: The unique ID to reference this session. Required. @@ -3439,114 +2958,60 @@ def get_liveness_with_verify_session_result( # response body for status code(s): 200 response == { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this session was - created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. Required. - "status": "str", # The current status of the session. Required. Known values - are: "NotStarted", "Started", and "ResultAvailable". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "status": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", "result": { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" }, - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime when this - session was started by the client. + "sessionStartDateTime": "2020-02-20 00:00:00" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -3601,7 +3066,6 @@ def get_liveness_with_verify_session_result( def get_liveness_with_verify_sessions( self, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionItem]: - # pylint: disable=line-too-long """Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the "start". @@ -3624,19 +3088,12 @@ def get_liveness_with_verify_sessions( # response body for status code(s): 200 response == [ { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this - session was created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. - Required. - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime - when this session was started by the client. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "sessionStartDateTime": "2020-02-20 00:00:00" } ] """ @@ -3693,7 +3150,6 @@ def get_liveness_with_verify_sessions( def get_liveness_with_verify_session_audit_entries( # pylint: disable=name-too-long self, session_id: str, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionAuditEntry]: - # pylint: disable=line-too-long """Gets session requests and response body for the session. :param session_id: The unique ID to reference this session. Required. @@ -3714,98 +3170,51 @@ def get_liveness_with_verify_session_audit_entries( # pylint: disable=name-too- # response body for status code(s): 200 response == [ { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" } ] """ diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_serialization.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_serialization.py index 2f781d740827a..8139854b97bb8 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_serialization.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_serialization.py @@ -144,6 +144,8 @@ def _json_attemp(data): # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -1441,7 +1443,7 @@ def _deserialize(self, target_obj, data): elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: attributes = response._attribute_map # type: ignore diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_version.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_version.py index bbcd28b4aa67e..be71c81bd2821 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_version.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.0b2" +VERSION = "1.0.0b1" diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/__init__.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/__init__.py index 25daed5ab3d4b..286cf760f66bf 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/__init__.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/__init__.py @@ -6,16 +6,20 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import FaceClient -from ._patch import FaceSessionClient - +from ._client import FaceClient +from ._client import FaceSessionClient +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__ = [ "FaceClient", "FaceSessionClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_client.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_client.py index 12cc8657e74aa..e3a86bff232b0 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_client.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, Awaitable, TYPE_CHECKING, Union +from typing_extensions import Self from azure.core import AsyncPipelineClient from azure.core.credentials import AzureKeyCredential @@ -98,7 +99,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "FaceClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self @@ -181,7 +182,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "FaceSessionClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_operations/_operations.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_operations/_operations.py index 30436b1ef06ad..ded9963f82dc6 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_operations/_operations.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_operations/_operations.py @@ -120,16 +120,18 @@ async def _detect_from_url( face_id_time_to_live: Optional[int] = None, **kwargs: Any ) -> List[_models.FaceDetectionResult]: - # pylint: disable=line-too-long """Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. .. [!IMPORTANT] - To mitigate potential misuse that can subject people to stereotyping, discrimination, or - unfair denial of services, we are retiring Face API attributes that predict emotion, gender, - age, smile, facial hair, hair, and makeup. Read more about this decision + Microsoft has retired or restricted facial recognition capabilities that can be used to try + to infer emotional states and identity attributes which, if misused, can subject people to + stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion + and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email + Azure Face API azureface@microsoft.com if you have a responsible use case that would benefit + from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. @@ -213,284 +215,183 @@ async def _detect_from_url( # JSON input template you can fill out and use as your body input. body = { - "url": "str" # URL of input image. Required. + "url": "str" } # response body for status code(s): 200 response == [ { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, "faceAttributes": { "accessories": [ { - "confidence": 0.0, # Confidence level of the - accessory type. Range between [0,1]. Required. - "type": "str" # Type of the accessory. - Required. Known values are: "headwear", "glasses", and "mask". + "confidence": 0.0, + "type": "str" } ], - "age": 0.0, # Optional. Age in years. + "age": 0.0, "blur": { - "blurLevel": "str", # An enum value indicating level - of blurriness. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of - blurriness ranging from 0 to 1. Required. + "blurLevel": "str", + "value": 0.0 }, "exposure": { - "exposureLevel": "str", # An enum value indicating - level of exposure. Required. Known values are: "underExposure", - "goodExposure", and "overExposure". - "value": 0.0 # A number indicating level of exposure - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. Required. + "exposureLevel": "str", + "value": 0.0 }, "facialHair": { - "beard": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "moustache": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "sideburns": 0.0 # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - }, - "glasses": "str", # Optional. Glasses type if any of the - face. Known values are: "noGlasses", "readingGlasses", "sunglasses", and - "swimmingGoggles". + "beard": 0.0, + "moustache": 0.0, + "sideburns": 0.0 + }, + "glasses": "str", "hair": { - "bald": 0.0, # A number describing confidence level - of whether the person is bald. Required. + "bald": 0.0, "hairColor": [ { - "color": "str", # Name of the hair - color. Required. Known values are: "unknown", "white", - "gray", "blond", "brown", "red", "black", and "other". - "confidence": 0.0 # Confidence level - of the color. Range between [0,1]. Required. + "color": "str", + "confidence": 0.0 } ], - "invisible": bool # A boolean value describing - whether the hair is visible in the image. Required. + "invisible": bool }, "headPose": { - "pitch": 0.0, # Value of angles. Required. - "roll": 0.0, # Value of angles. Required. - "yaw": 0.0 # Value of angles. Required. + "pitch": 0.0, + "roll": 0.0, + "yaw": 0.0 }, "mask": { - "noseAndMouthCovered": bool, # A boolean value - indicating whether nose and mouth are covered. Required. - "type": "str" # Type of the mask. Required. Known - values are: "faceMask", "noMask", "otherMaskOrOcclusion", and - "uncertain". + "noseAndMouthCovered": bool, + "type": "str" }, "noise": { - "noiseLevel": "str", # An enum value indicating - level of noise. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of noise - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. [0, 0.3) is low noise - level. [0.3, 0.7) is medium noise level. [0.7, 1] is high noise - level. Required. + "noiseLevel": "str", + "value": 0.0 }, "occlusion": { - "eyeOccluded": bool, # A boolean value indicating - whether eyes are occluded. Required. - "foreheadOccluded": bool, # A boolean value - indicating whether forehead is occluded. Required. - "mouthOccluded": bool # A boolean value indicating - whether the mouth is occluded. Required. - }, - "qualityForRecognition": "str", # Optional. Properties - describing the overall image quality regarding whether the image being - used in the detection is of sufficient quality to attempt face - recognition on. Known values are: "low", "medium", and "high". - "smile": 0.0 # Optional. Smile intensity, a number between - [0,1]. + "eyeOccluded": bool, + "foreheadOccluded": bool, + "mouthOccluded": bool + }, + "qualityForRecognition": "str", + "smile": 0.0 }, - "faceId": "str", # Optional. Unique faceId of the detected face, - created by detection API and it will expire 24 hours after the detection - call. To return this, it requires 'returnFaceId' parameter to be true. + "faceId": "str", "faceLandmarks": { "eyeLeftBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 } }, - "recognitionModel": "str" # Optional. The 'recognitionModel' - associated with this faceId. This is only returned when - 'returnRecognitionModel' is explicitly set as true. Known values are: - "recognition_01", "recognition_02", "recognition_03", and "recognition_04". + "recognitionModel": "str" } ] """ @@ -577,16 +478,18 @@ async def _detect( face_id_time_to_live: Optional[int] = None, **kwargs: Any ) -> List[_models.FaceDetectionResult]: - # pylint: disable=line-too-long """Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes. .. [!IMPORTANT] - To mitigate potential misuse that can subject people to stereotyping, discrimination, or - unfair denial of services, we are retiring Face API attributes that predict emotion, gender, - age, smile, facial hair, hair, and makeup. Read more about this decision + Microsoft has retired or restricted facial recognition capabilities that can be used to try + to infer emotional states and identity attributes which, if misused, can subject people to + stereotyping, discrimination or unfair denial of services. The retired capabilities are emotion + and gender. The restricted capabilities are age, smile, facial hair, hair and makeup. Email + Azure Face API azureface@microsoft.com if you have a responsible use case that would benefit + from the use of any of the restricted capabilities. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/. @@ -670,277 +573,176 @@ async def _detect( response == [ { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, "faceAttributes": { "accessories": [ { - "confidence": 0.0, # Confidence level of the - accessory type. Range between [0,1]. Required. - "type": "str" # Type of the accessory. - Required. Known values are: "headwear", "glasses", and "mask". + "confidence": 0.0, + "type": "str" } ], - "age": 0.0, # Optional. Age in years. + "age": 0.0, "blur": { - "blurLevel": "str", # An enum value indicating level - of blurriness. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of - blurriness ranging from 0 to 1. Required. + "blurLevel": "str", + "value": 0.0 }, "exposure": { - "exposureLevel": "str", # An enum value indicating - level of exposure. Required. Known values are: "underExposure", - "goodExposure", and "overExposure". - "value": 0.0 # A number indicating level of exposure - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. Required. + "exposureLevel": "str", + "value": 0.0 }, "facialHair": { - "beard": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "moustache": 0.0, # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - "sideburns": 0.0 # A number ranging from 0 to 1 - indicating a level of confidence associated with a property. - Required. - }, - "glasses": "str", # Optional. Glasses type if any of the - face. Known values are: "noGlasses", "readingGlasses", "sunglasses", and - "swimmingGoggles". + "beard": 0.0, + "moustache": 0.0, + "sideburns": 0.0 + }, + "glasses": "str", "hair": { - "bald": 0.0, # A number describing confidence level - of whether the person is bald. Required. + "bald": 0.0, "hairColor": [ { - "color": "str", # Name of the hair - color. Required. Known values are: "unknown", "white", - "gray", "blond", "brown", "red", "black", and "other". - "confidence": 0.0 # Confidence level - of the color. Range between [0,1]. Required. + "color": "str", + "confidence": 0.0 } ], - "invisible": bool # A boolean value describing - whether the hair is visible in the image. Required. + "invisible": bool }, "headPose": { - "pitch": 0.0, # Value of angles. Required. - "roll": 0.0, # Value of angles. Required. - "yaw": 0.0 # Value of angles. Required. + "pitch": 0.0, + "roll": 0.0, + "yaw": 0.0 }, "mask": { - "noseAndMouthCovered": bool, # A boolean value - indicating whether nose and mouth are covered. Required. - "type": "str" # Type of the mask. Required. Known - values are: "faceMask", "noMask", "otherMaskOrOcclusion", and - "uncertain". + "noseAndMouthCovered": bool, + "type": "str" }, "noise": { - "noiseLevel": "str", # An enum value indicating - level of noise. Required. Known values are: "low", "medium", and - "high". - "value": 0.0 # A number indicating level of noise - level ranging from 0 to 1. [0, 0.25) is under exposure. [0.25, 0.75) - is good exposure. [0.75, 1] is over exposure. [0, 0.3) is low noise - level. [0.3, 0.7) is medium noise level. [0.7, 1] is high noise - level. Required. + "noiseLevel": "str", + "value": 0.0 }, "occlusion": { - "eyeOccluded": bool, # A boolean value indicating - whether eyes are occluded. Required. - "foreheadOccluded": bool, # A boolean value - indicating whether forehead is occluded. Required. - "mouthOccluded": bool # A boolean value indicating - whether the mouth is occluded. Required. - }, - "qualityForRecognition": "str", # Optional. Properties - describing the overall image quality regarding whether the image being - used in the detection is of sufficient quality to attempt face - recognition on. Known values are: "low", "medium", and "high". - "smile": 0.0 # Optional. Smile intensity, a number between - [0,1]. + "eyeOccluded": bool, + "foreheadOccluded": bool, + "mouthOccluded": bool + }, + "qualityForRecognition": "str", + "smile": 0.0 }, - "faceId": "str", # Optional. Unique faceId of the detected face, - created by detection API and it will expire 24 hours after the detection - call. To return this, it requires 'returnFaceId' parameter to be true. + "faceId": "str", "faceLandmarks": { "eyeLeftBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeLeftTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyeRightTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowLeftOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightInner": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "eyebrowRightOuter": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "mouthRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseLeftAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarOutTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRightAlarTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseRootRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "noseTip": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilLeft": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "pupilRight": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "underLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipBottom": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 }, "upperLipTop": { - "x": 0.0, # The horizontal component, in pixels. - Required. - "y": 0.0 # The vertical component, in pixels. - Required. + "x": 0.0, + "y": 0.0 } }, - "recognitionModel": "str" # Optional. The 'recognitionModel' - associated with this faceId. This is only returned when - 'returnRecognitionModel' is explicitly set as true. Known values are: - "recognition_01", "recognition_02", "recognition_03", and "recognition_04". + "recognitionModel": "str" } ] """ @@ -1007,7 +809,6 @@ async def _detect( async def find_similar( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1038,32 +839,20 @@ async def find_similar( # JSON input template you can fill out and use as your body input. body = { - "faceId": "str", # faceId of the query face. User needs to call "Detect" - first to get a valid faceId. Note that this faceId is not persisted and will - expire 24 hours after the detection call. Required. + "faceId": "str", "faceIds": [ - "str" # An array of candidate faceIds. All of them are created by - "Detect" and the faceIds will expire 24 hours after the detection call. The - number of faceIds is limited to 1000. Required. + "str" ], - "maxNumOfCandidatesReturned": 0, # Optional. The number of top similar faces - returned. The valid range is [1, 1000]. Default value is 20. - "mode": "str" # Optional. Similar face searching mode. It can be - 'matchPerson' or 'matchFace'. Default value is 'matchPerson'. Known values are: - "matchPerson" and "matchFace". + "maxNumOfCandidatesReturned": 0, + "mode": "str" } # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1079,7 +868,6 @@ async def find_similar( mode: Optional[Union[str, _models.FindSimilarMatchMode]] = None, **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1123,14 +911,9 @@ async def find_similar( # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1139,7 +922,6 @@ async def find_similar( async def find_similar( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1171,14 +953,9 @@ async def find_similar( # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1194,7 +971,6 @@ async def find_similar( mode: Optional[Union[str, _models.FindSimilarMatchMode]] = None, **kwargs: Any ) -> List[_models.FaceFindSimilarResult]: - # pylint: disable=line-too-long """Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect. @@ -1236,32 +1012,20 @@ async def find_similar( # JSON input template you can fill out and use as your body input. body = { - "faceId": "str", # faceId of the query face. User needs to call "Detect" - first to get a valid faceId. Note that this faceId is not persisted and will - expire 24 hours after the detection call. Required. + "faceId": "str", "faceIds": [ - "str" # An array of candidate faceIds. All of them are created by - "Detect" and the faceIds will expire 24 hours after the detection call. The - number of faceIds is limited to 1000. Required. + "str" ], - "maxNumOfCandidatesReturned": 0, # Optional. The number of top similar faces - returned. The valid range is [1, 1000]. Default value is 20. - "mode": "str" # Optional. Similar face searching mode. It can be - 'matchPerson' or 'matchFace'. Default value is 'matchPerson'. Known values are: - "matchPerson" and "matchFace". + "maxNumOfCandidatesReturned": 0, + "mode": "str" } # response body for status code(s): 200 response == [ { - "confidence": 0.0, # Confidence value of the candidate. The higher - confidence, the more similar. Range between [0,1]. Required. - "faceId": "str", # Optional. faceId of candidate face when find by - faceIds. faceId is created by "Detect" and will expire 24 hours after the - detection call. - "persistedFaceId": "str" # Optional. persistedFaceId of candidate - face when find by faceListId or largeFaceListId. persistedFaceId in face - list/large face list is persisted and will not expire. + "confidence": 0.0, + "faceId": "str", + "persistedFaceId": "str" } ] """ @@ -1285,9 +1049,9 @@ async def find_similar( if face_ids is _Unset: raise TypeError("missing required argument: face_ids") body = { - "faceid": face_id, - "faceids": face_ids, - "maxnumofcandidatesreturned": max_num_of_candidates_returned, + "faceId": face_id, + "faceIds": face_ids, + "maxNumOfCandidatesReturned": max_num_of_candidates_returned, "mode": mode, } body = {k: v for k, v in body.items() if v is not None} @@ -1338,7 +1102,6 @@ async def find_similar( async def verify_face_to_face( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1368,19 +1131,14 @@ async def verify_face_to_face( # JSON input template you can fill out and use as your body input. body = { - "faceId1": "str", # The faceId of one face, come from "Detect". Required. - "faceId2": "str" # The faceId of another face, come from "Detect". Required. + "faceId1": "str", + "faceId2": "str" } # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1388,7 +1146,6 @@ async def verify_face_to_face( async def verify_face_to_face( self, *, face_id1: str, face_id2: str, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1420,13 +1177,8 @@ async def verify_face_to_face( # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1434,7 +1186,6 @@ async def verify_face_to_face( async def verify_face_to_face( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1464,13 +1215,8 @@ async def verify_face_to_face( # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ @@ -1478,7 +1224,6 @@ async def verify_face_to_face( async def verify_face_to_face( self, body: Union[JSON, IO[bytes]] = _Unset, *, face_id1: str = _Unset, face_id2: str = _Unset, **kwargs: Any ) -> _models.FaceVerificationResult: - # pylint: disable=line-too-long """Verify whether two faces belong to a same person. .. @@ -1509,19 +1254,14 @@ async def verify_face_to_face( # JSON input template you can fill out and use as your body input. body = { - "faceId1": "str", # The faceId of one face, come from "Detect". Required. - "faceId2": "str" # The faceId of another face, come from "Detect". Required. + "faceId1": "str", + "faceId2": "str" } # response body for status code(s): 200 response == { - "confidence": 0.0, # A number indicates the similarity confidence of whether - two faces belong to the same person, or whether the face belongs to the person. - By default, isIdentical is set to True if similarity confidence is greater than - or equal to 0.5. This is useful for advanced users to override 'isIdentical' and - fine-tune the result on their own data. Required. - "isIdentical": bool # True if the two faces belong to the same person or the - face belongs to the person, otherwise false. Required. + "confidence": 0.0, + "isIdentical": bool } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -1543,7 +1283,7 @@ async def verify_face_to_face( raise TypeError("missing required argument: face_id1") if face_id2 is _Unset: raise TypeError("missing required argument: face_id2") - body = {"faceid1": face_id1, "faceid2": face_id2} + body = {"faceId1": face_id1, "faceId2": face_id2} body = {k: v for k, v in body.items() if v is not None} content_type = content_type or "application/json" _content = None @@ -1592,7 +1332,6 @@ async def verify_face_to_face( async def group( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -1625,8 +1364,7 @@ async def group( # JSON input template you can fill out and use as your body input. body = { "faceIds": [ - "str" # Array of candidate faceIds created by "Detect". The maximum - is 1000 faces. Required. + "str" ] } @@ -1634,13 +1372,11 @@ async def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -1649,7 +1385,6 @@ async def group( async def group( self, *, face_ids: List[str], content_type: str = "application/json", **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -1684,13 +1419,11 @@ async def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -1699,7 +1432,6 @@ async def group( async def group( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -1733,13 +1465,11 @@ async def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -1748,7 +1478,6 @@ async def group( async def group( self, body: Union[JSON, IO[bytes]] = _Unset, *, face_ids: List[str] = _Unset, **kwargs: Any ) -> _models.FaceGroupingResult: - # pylint: disable=line-too-long """Divide candidate faces into groups based on face similarity. > @@ -1781,8 +1510,7 @@ async def group( # JSON input template you can fill out and use as your body input. body = { "faceIds": [ - "str" # Array of candidate faceIds created by "Detect". The maximum - is 1000 faces. Required. + "str" ] } @@ -1790,13 +1518,11 @@ async def group( response == { "groups": [ [ - "str" # A partition of the original faces based on face - similarity. Groups are ranked by number of faces. Required. + "str" ] ], "messyGroup": [ - "str" # Face ids array of faces that cannot find any similar faces - from original faces. Required. + "str" ] } """ @@ -1817,7 +1543,7 @@ async def group( if body is _Unset: if face_ids is _Unset: raise TypeError("missing required argument: face_ids") - body = {"faceids": face_ids} + body = {"faceIds": face_ids} body = {k: v for k, v in body.items() if v is not None} content_type = content_type or "application/json" _content = None @@ -1869,7 +1595,6 @@ class FaceSessionClientOperationsMixin(FaceSessionClientMixinABC): async def create_liveness_session( self, body: _models.CreateLivenessSessionContent, *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -1892,7 +1617,7 @@ async def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -1907,33 +1632,17 @@ async def create_liveness_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -1941,7 +1650,6 @@ async def create_liveness_session( async def create_liveness_session( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -1964,7 +1672,7 @@ async def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -1979,13 +1687,8 @@ async def create_liveness_session( # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -1993,7 +1696,6 @@ async def create_liveness_session( async def create_liveness_session( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2016,7 +1718,7 @@ async def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -2031,13 +1733,8 @@ async def create_liveness_session( # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ @@ -2045,7 +1742,6 @@ async def create_liveness_session( async def create_liveness_session( self, body: Union[_models.CreateLivenessSessionContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.CreateLivenessSessionResult: - # pylint: disable=line-too-long """Create a new detect liveness session. A session is best for client device scenarios where developers want to authorize a client @@ -2068,8 +1764,8 @@ async def create_liveness_session( operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries. - :param body: Is one of the following types: CreateLivenessSessionContent, JSON, IO[bytes] - Required. + :param body: Body parameter. Is one of the following types: CreateLivenessSessionContent, JSON, + IO[bytes] Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent or JSON or IO[bytes] :return: CreateLivenessSessionResult. The CreateLivenessSessionResult is compatible with MutableMapping @@ -2081,33 +1777,17 @@ async def create_liveness_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str" # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -2219,8 +1899,6 @@ async def delete_liveness_session( # pylint: disable=inconsistent-return-statem 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.FaceErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) @@ -2230,7 +1908,6 @@ async def delete_liveness_session( # pylint: disable=inconsistent-return-statem @distributed_trace_async async def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _models.LivenessSession: - # pylint: disable=line-too-long """Get session result of detectLiveness/singleModal call. :param session_id: The unique ID to reference this session. Required. @@ -2244,114 +1921,60 @@ async def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _ # response body for status code(s): 200 response == { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this session was - created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. Required. - "status": "str", # The current status of the session. Required. Known values - are: "NotStarted", "Started", and "ResultAvailable". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "status": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", "result": { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" }, - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime when this - session was started by the client. + "sessionStartDateTime": "2020-02-20 00:00:00" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -2406,7 +2029,6 @@ async def get_liveness_session_result(self, session_id: str, **kwargs: Any) -> _ async def get_liveness_sessions( self, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionItem]: - # pylint: disable=line-too-long """Lists sessions for /detectLiveness/SingleModal. List sessions from the last sessionId greater than the 'start'. @@ -2429,19 +2051,12 @@ async def get_liveness_sessions( # response body for status code(s): 200 response == [ { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this - session was created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. - Required. - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime - when this session was started by the client. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "sessionStartDateTime": "2020-02-20 00:00:00" } ] """ @@ -2498,7 +2113,6 @@ async def get_liveness_sessions( async def get_liveness_session_audit_entries( self, session_id: str, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionAuditEntry]: - # pylint: disable=line-too-long """Gets session requests and response body for the session. :param session_id: The unique ID to reference this session. Required. @@ -2519,98 +2133,51 @@ async def get_liveness_session_audit_entries( # response body for status code(s): 200 response == [ { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" } ] """ @@ -2681,7 +2248,6 @@ async def _create_liveness_with_verify_session( async def _create_liveness_with_verify_session( self, body: Union[_models.CreateLivenessSessionContent, JSON, IO[bytes]], **kwargs: Any ) -> _models.CreateLivenessWithVerifySessionResult: - # pylint: disable=line-too-long """Create a new liveness session with verify. Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. @@ -2721,8 +2287,8 @@ async def _create_liveness_with_verify_session( Extra measures should be taken to validate that the client is sending the expected VerifyImage. - :param body: Is one of the following types: CreateLivenessSessionContent, JSON, IO[bytes] - Required. + :param body: Body parameter. Is one of the following types: CreateLivenessSessionContent, JSON, + IO[bytes] Required. :type body: ~azure.ai.vision.face.models.CreateLivenessSessionContent or JSON or IO[bytes] :return: CreateLivenessWithVerifySessionResult. The CreateLivenessWithVerifySessionResult is compatible with MutableMapping @@ -2734,46 +2300,25 @@ async def _create_liveness_with_verify_session( # JSON input template you can fill out and use as your body input. body = { - "livenessOperationMode": "str", # Type of liveness mode the client should - follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not to allow - client to set their own 'deviceCorrelationId' via the Vision SDK. Default is - false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a '200 - - Success' response body to be sent to the client, which may be undesirable for - security reasons. Default is false, clients will receive a '204 - NoContent' - empty body response. Regardless of selection, calling Session GetResult will - always contain a response body enabling business logic to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str", # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str", "verifyImage": { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # Quality of face image for - recognition. Required. Known values are: "low", "medium", and "high". + "qualityForRecognition": "str" } } """ @@ -2847,7 +2392,6 @@ async def _create_liveness_with_verify_session_with_verify_image( # pylint: dis async def _create_liveness_with_verify_session_with_verify_image( # pylint: disable=name-too-long self, body: Union[_models._models.CreateLivenessWithVerifySessionContent, JSON], **kwargs: Any ) -> _models.CreateLivenessWithVerifySessionResult: - # pylint: disable=line-too-long """Create a new liveness session with verify. Provide the verify image during session creation. A session is best for client device scenarios where developers want to authorize a client @@ -2892,49 +2436,27 @@ async def _create_liveness_with_verify_session_with_verify_image( # pylint: dis # JSON input template you can fill out and use as your body input. body = { "Parameters": { - "livenessOperationMode": "str", # Type of liveness mode the client - should follow. Required. Known values are: "Passive" and "PassiveActive". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "deviceCorrelationIdSetInClient": bool, # Optional. Whether or not - to allow client to set their own 'deviceCorrelationId' via the Vision SDK. - Default is false, and 'deviceCorrelationId' must be set in this request body. - "sendResultsToClient": bool # Optional. Whether or not to allow a - '200 - Success' response body to be sent to the client, which may be - undesirable for security reasons. Default is false, clients will receive a - '204 - NoContent' empty body response. Regardless of selection, calling - Session GetResult will always contain a response body enabling business logic - to be implemented. + "livenessOperationMode": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "deviceCorrelationIdSetInClient": bool, + "sendResultsToClient": bool }, "VerifyImage": filetype } # response body for status code(s): 200 response == { - "authToken": "str", # Bearer token to provide authentication for the Vision - SDK running on a client application. This Bearer token has limited permissions to - perform only the required action and expires after the TTL time. It is also - auditable. Required. - "sessionId": "str", # The unique session ID of the created session. It will - expire 48 hours after it was created or may be deleted sooner using the - corresponding Session DELETE operation. Required. + "authToken": "str", + "sessionId": "str", "verifyImage": { "faceRectangle": { - "height": 0, # The height of the rectangle, in pixels. - Required. - "left": 0, # The distance from the left edge if the image to - the left edge of the rectangle, in pixels. Required. - "top": 0, # The distance from the top edge if the image to - the top edge of the rectangle, in pixels. Required. - "width": 0 # The width of the rectangle, in pixels. - Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # Quality of face image for - recognition. Required. Known values are: "low", "medium", and "high". + "qualityForRecognition": "str" } } """ @@ -3044,8 +2566,6 @@ async def delete_liveness_with_verify_session( # pylint: disable=inconsistent-r 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.FaceErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) @@ -3057,7 +2577,6 @@ async def delete_liveness_with_verify_session( # pylint: disable=inconsistent-r async def get_liveness_with_verify_session_result( self, session_id: str, **kwargs: Any ) -> _models.LivenessWithVerifySession: - # pylint: disable=line-too-long """Get session result of detectLivenessWithVerify/singleModal call. :param session_id: The unique ID to reference this session. Required. @@ -3072,114 +2591,60 @@ async def get_liveness_with_verify_session_result( # response body for status code(s): 200 response == { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this session was - created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. Required. - "status": "str", # The current status of the session. Required. Known values - are: "NotStarted", "Started", and "ResultAvailable". - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session should - last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each end-user - device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "status": "str", + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", "result": { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" }, - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime when this - session was started by the client. + "sessionStartDateTime": "2020-02-20 00:00:00" } """ error_map: MutableMapping[int, Type[HttpResponseError]] = { @@ -3234,7 +2699,6 @@ async def get_liveness_with_verify_session_result( async def get_liveness_with_verify_sessions( self, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionItem]: - # pylint: disable=line-too-long """Lists sessions for /detectLivenessWithVerify/SingleModal. List sessions from the last sessionId greater than the "start". @@ -3257,19 +2721,12 @@ async def get_liveness_with_verify_sessions( # response body for status code(s): 200 response == [ { - "createdDateTime": "2020-02-20 00:00:00", # DateTime when this - session was created. Required. - "id": "str", # The unique ID to reference this session. Required. - "sessionExpired": bool, # Whether or not the session is expired. - Required. - "authTokenTimeToLiveInSeconds": 0, # Optional. Seconds the session - should last for. Range is 60 to 86400 seconds. Default value is 600. - "deviceCorrelationId": "str", # Optional. Unique Guid per each - end-user device. This is to provide rate limiting and anti-hammering. If - 'deviceCorrelationIdSetInClient' is true in this request, this - 'deviceCorrelationId' must be null. - "sessionStartDateTime": "2020-02-20 00:00:00" # Optional. DateTime - when this session was started by the client. + "createdDateTime": "2020-02-20 00:00:00", + "id": "str", + "sessionExpired": bool, + "authTokenTimeToLiveInSeconds": 0, + "deviceCorrelationId": "str", + "sessionStartDateTime": "2020-02-20 00:00:00" } ] """ @@ -3326,7 +2783,6 @@ async def get_liveness_with_verify_sessions( async def get_liveness_with_verify_session_audit_entries( # pylint: disable=name-too-long self, session_id: str, *, start: Optional[str] = None, top: Optional[int] = None, **kwargs: Any ) -> List[_models.LivenessSessionAuditEntry]: - # pylint: disable=line-too-long """Gets session requests and response body for the session. :param session_id: The unique ID to reference this session. Required. @@ -3347,98 +2803,51 @@ async def get_liveness_with_verify_session_audit_entries( # pylint: disable=nam # response body for status code(s): 200 response == [ { - "clientRequestId": "str", # The unique clientRequestId that is sent - by the client in the 'client-request-id' header. Required. - "digest": "str", # The server calculated digest for this request. If - the client reported digest differs from the server calculated digest, then - the message integrity between the client and service has been compromised and - the result should not be trusted. For more information, see how to guides on - how to leverage this value to secure your end-to-end solution. Required. - "id": 0, # The unique id to refer to this audit request. Use this id - with the 'start' query parameter to continue on to the next page of audit - results. Required. - "receivedDateTime": "2020-02-20 00:00:00", # The UTC DateTime that - the request was received. Required. + "clientRequestId": "str", + "digest": "str", + "id": 0, + "receivedDateTime": "2020-02-20 00:00:00", "request": { - "contentType": "str", # The content type of the request. - Required. - "method": "str", # The HTTP method of the request (i.e., - GET, POST, DELETE). Required. - "url": "str", # The relative URL and query of the liveness - request. Required. - "contentLength": 0, # Optional. The length of the request - body in bytes. - "userAgent": "str" # Optional. The user agent used to submit - the request. + "contentType": "str", + "method": "str", + "url": "str", + "contentLength": 0, + "userAgent": "str" }, - "requestId": "str", # The unique requestId that is returned by the - service to the client in the 'apim-request-id' header. Required. + "requestId": "str", "response": { "body": { - "livenessDecision": "str", # Optional. The liveness - classification for the target face. Known values are: "uncertain", - "realface", and "spoofface". - "modelVersionUsed": "str", # Optional. The model - version used for liveness classification. Known values are: - "2020-02-15-preview.01", "2021-11-12-preview.03", - "2022-10-15-preview.04", and "2023-03-02-preview.05". + "livenessDecision": "str", + "modelVersionUsed": "str", "target": { "faceRectangle": { - "height": 0, # The height of the - rectangle, in pixels. Required. - "left": 0, # The distance from the - left edge if the image to the left edge of the rectangle, in - pixels. Required. - "top": 0, # The distance from the - top edge if the image to the top edge of the rectangle, in - pixels. Required. - "width": 0 # The width of the - rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "fileName": "str", # The file name which - contains the face rectangle where the liveness classification was - made on. Required. - "imageType": "str", # The image type which - contains the face rectangle where the liveness classification was - made on. Required. Known values are: "Color", "Infrared", and - "Depth". - "timeOffsetWithinFile": 0 # The time offset - within the file of the frame which contains the face rectangle - where the liveness classification was made on. Required. + "fileName": "str", + "imageType": "str", + "timeOffsetWithinFile": 0 }, "verifyResult": { - "isIdentical": bool, # Whether the target - liveness face and comparison image face match. Required. - "matchConfidence": 0.0, # The target face - liveness face and comparison image face verification confidence. - Required. + "isIdentical": bool, + "matchConfidence": 0.0, "verifyImage": { "faceRectangle": { - "height": 0, # The height of - the rectangle, in pixels. Required. - "left": 0, # The distance - from the left edge if the image to the left edge of the - rectangle, in pixels. Required. - "top": 0, # The distance - from the top edge if the image to the top edge of the - rectangle, in pixels. Required. - "width": 0 # The width of - the rectangle, in pixels. Required. + "height": 0, + "left": 0, + "top": 0, + "width": 0 }, - "qualityForRecognition": "str" # - Quality of face image for recognition. Required. Known values - are: "low", "medium", and "high". + "qualityForRecognition": "str" } } }, - "latencyInMilliseconds": 0, # The server measured latency - for this request in milliseconds. Required. - "statusCode": 0 # The HTTP status code returned to the - client. Required. + "latencyInMilliseconds": 0, + "statusCode": 0 }, - "sessionId": "str" # The unique sessionId of the created session. It - will expire 48 hours after it was created or may be deleted sooner using the - corresponding session DELETE operation. Required. + "sessionId": "str" } ] """ diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/__init__.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/__init__.py index 7fceddaf6baaa..754231dcb9a5c 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/__init__.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/__init__.py @@ -58,18 +58,11 @@ from ._enums import NoiseLevel from ._enums import QualityForRecognition from ._enums import Versions - -from ._patch import FaceAttributeTypeDetection01 -from ._patch import FaceAttributeTypeDetection03 -from ._patch import FaceAttributeTypeRecognition03 -from ._patch import FaceAttributeTypeRecognition04 +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import from ._patch import patch_sdk as _patch_sdk __all__ = [ - "FaceAttributeTypeDetection01", - "FaceAttributeTypeDetection03", - "FaceAttributeTypeRecognition03", - "FaceAttributeTypeRecognition04", "AccessoryItem", "AuditLivenessResponseInfo", "AuditRequestInfo", @@ -122,5 +115,5 @@ "QualityForRecognition", "Versions", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_models.py b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_models.py index 06bb6e5db83ce..dccc390619d38 100644 --- a/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_models.py +++ b/sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_models.py @@ -29,7 +29,6 @@ class AccessoryItem(_model_base.Model): """Accessory item and corresponding confidence level. - All required parameters must be populated in order to send to server. :ivar type: Type of the accessory. Required. Known values are: "headwear", "glasses", and "mask". @@ -65,7 +64,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AuditLivenessResponseInfo(_model_base.Model): """Audit entry for a response in the session. - All required parameters must be populated in order to send to server. :ivar body: The response body. The schema of this field will depend on the request.url and request.method used by the client. Required. @@ -108,7 +106,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class AuditRequestInfo(_model_base.Model): """Audit entry for a request in the session. - All required parameters must be populated in order to send to server. :ivar url: The relative URL and query of the liveness request. Required. :vartype url: str @@ -158,7 +155,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class BlurProperties(_model_base.Model): """Properties describing any presence of blur within the image. - All required parameters must be populated in order to send to server. :ivar blur_level: An enum value indicating level of blurriness. Required. Known values are: "low", "medium", and "high". @@ -261,7 +257,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class CreateLivenessSessionResult(_model_base.Model): """Response of liveness session creation. - All required parameters must be populated in order to send to server. :ivar session_id: The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation. @@ -322,7 +317,6 @@ class CreateLivenessWithVerifySessionContent(_model_base.Model): class CreateLivenessWithVerifySessionResult(_model_base.Model): """Response of liveness session with verify creation with verify image provided. - All required parameters must be populated in order to send to server. :ivar session_id: The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation. @@ -369,7 +363,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class ExposureProperties(_model_base.Model): """Properties describing exposure level of the image. - All required parameters must be populated in order to send to server. :ivar exposure_level: An enum value indicating level of exposure. Required. Known values are: "underExposure", "goodExposure", and "overExposure". @@ -504,7 +497,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceDetectionResult(_model_base.Model): """Response for detect API. - All required parameters must be populated in order to send to server. :ivar face_id: Unique faceId of the detected face, created by detection API and it will expire 24 hours after the detection call. To return this, it requires 'returnFaceId' parameter to be @@ -564,7 +556,6 @@ class FaceError(_model_base.Model): """The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages. - 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 @@ -599,7 +590,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceErrorResponse(_model_base.Model): """A response containing error details. - All required parameters must be populated in order to send to server. :ivar error: The error object. Required. :vartype error: ~azure.ai.vision.face.models.FaceError @@ -629,7 +619,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceFindSimilarResult(_model_base.Model): """Response body for find similar face operation. - All required parameters must be populated in order to send to server. :ivar confidence: Confidence value of the candidate. The higher confidence, the more similar. Range between [0,1]. Required. @@ -675,7 +664,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceGroupingResult(_model_base.Model): """Response body for group face operation. - All required parameters must be populated in order to send to server. :ivar groups: A partition of the original faces based on face similarity. Groups are ranked by number of faces. Required. @@ -713,7 +701,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceLandmarks(_model_base.Model): # pylint: disable=too-many-instance-attributes """A collection of 27-point face landmarks pointing to the important positions of face components. - All required parameters must be populated in order to send to server. :ivar pupil_left: The coordinates of the left eye pupil. Required. :vartype pupil_left: ~azure.ai.vision.face.models.LandmarkCoordinate @@ -827,7 +814,7 @@ class FaceLandmarks(_model_base.Model): # pylint: disable=too-many-instance-att """The coordinates of the under lip bottom. Required.""" @overload - def __init__( # pylint: disable=too-many-locals + def __init__( self, *, pupil_left: "_models.LandmarkCoordinate", @@ -873,7 +860,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceRectangle(_model_base.Model): """A rectangle within which a face can be found. - All required parameters must be populated in order to send to server. :ivar top: The distance from the top edge if the image to the top edge of the rectangle, in pixels. Required. @@ -922,7 +908,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FaceVerificationResult(_model_base.Model): """Verify result. - All required parameters must be populated in order to send to server. :ivar is_identical: True if the two faces belong to the same person or the face belongs to the person, otherwise false. Required. @@ -965,7 +950,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class FacialHair(_model_base.Model): """Properties describing facial hair attributes. - All required parameters must be populated in order to send to server. :ivar moustache: A number ranging from 0 to 1 indicating a level of confidence associated with a property. Required. @@ -1011,7 +995,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class HairColor(_model_base.Model): """An array of candidate colors and confidence level in the presence of each. - All required parameters must be populated in order to send to server. :ivar color: Name of the hair color. Required. Known values are: "unknown", "white", "gray", "blond", "brown", "red", "black", and "other". @@ -1048,7 +1031,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class HairProperties(_model_base.Model): """Properties describing hair attributes. - All required parameters must be populated in order to send to server. :ivar bald: A number describing confidence level of whether the person is bald. Required. :vartype bald: float @@ -1089,7 +1071,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class HeadPose(_model_base.Model): """3-D roll/yaw/pitch angles for face direction. - All required parameters must be populated in order to send to server. :ivar pitch: Value of angles. Required. :vartype pitch: float @@ -1129,7 +1110,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class LandmarkCoordinate(_model_base.Model): """Landmark coordinates within an image. - All required parameters must be populated in order to send to server. :ivar x: The horizontal component, in pixels. Required. :vartype x: float @@ -1164,7 +1144,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class LivenessOutputsTarget(_model_base.Model): """The liveness classification for target face. - All required parameters must be populated in order to send to server. :ivar face_rectangle: The face region where the liveness classification was made on. Required. :vartype face_rectangle: ~azure.ai.vision.face.models.FaceRectangle @@ -1267,7 +1246,6 @@ class LivenessSession(_model_base.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 id: The unique ID to reference this session. Required. :vartype id: str @@ -1338,7 +1316,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class LivenessSessionAuditEntry(_model_base.Model): """Audit entry for a request in session. - All required parameters must be populated in order to send to server. :ivar id: The unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results. Required. @@ -1420,7 +1397,6 @@ class LivenessSessionItem(_model_base.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 id: The unique ID to reference this session. Required. :vartype id: str @@ -1479,7 +1455,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class LivenessWithVerifyImage(_model_base.Model): """The detail of face for verification. - All required parameters must be populated in order to send to server. :ivar face_rectangle: The face region where the comparison image's classification was made. Required. @@ -1517,7 +1492,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class LivenessWithVerifyOutputs(_model_base.Model): """The face verification output. - All required parameters must be populated in order to send to server. :ivar verify_image: The detail of face for verification. Required. :vartype verify_image: ~azure.ai.vision.face.models.LivenessWithVerifyImage @@ -1560,7 +1534,6 @@ class LivenessWithVerifySession(_model_base.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 id: The unique ID to reference this session. Required. :vartype id: str @@ -1631,7 +1604,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class MaskProperties(_model_base.Model): """Properties describing the presence of a mask on a given face. - All required parameters must be populated in order to send to server. :ivar nose_and_mouth_covered: A boolean value indicating whether nose and mouth are covered. Required. @@ -1669,7 +1641,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class NoiseProperties(_model_base.Model): """Properties describing noise level of the image. - All required parameters must be populated in order to send to server. :ivar noise_level: An enum value indicating level of noise. Required. Known values are: "low", "medium", and "high". @@ -1710,7 +1681,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useles class OcclusionProperties(_model_base.Model): """Properties describing occlusions on a given face. - All required parameters must be populated in order to send to server. :ivar forehead_occluded: A boolean value indicating whether forehead is occluded. Required. :vartype forehead_occluded: bool diff --git a/sdk/face/azure-ai-vision-face/samples/sample_authentication.py b/sdk/face/azure-ai-vision-face/samples/sample_authentication.py index 54562a238a39a..984bd530df4ec 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_authentication.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_authentication.py @@ -44,12 +44,8 @@ class FaceAuthentication: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_authentication") def authentication_by_api_key(self): @@ -58,9 +54,7 @@ def authentication_by_api_key(self): from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel self.logger.info("Instantiate a FaceClient using an api key") - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.DEFAULT_IMAGE_FILE) result = face_client.detect( helpers.read_file_content(sample_file_path), @@ -80,9 +74,7 @@ def authentication_by_aad_credential(self): from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel self.logger.info("Instantiate a FaceClient using a TokenCredential") - with FaceClient( - endpoint=self.endpoint, credential=DefaultAzureCredential() - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=DefaultAzureCredential()) as face_client: sample_file_path = helpers.get_image_path(TestImages.DEFAULT_IMAGE_FILE) result = face_client.detect( helpers.read_file_content(sample_file_path), diff --git a/sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py b/sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py index 2f9763fe21e91..eb13ca71bb01c 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py @@ -45,12 +45,8 @@ class FaceAuthentication: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_authentication_async") async def authentication_by_api_key(self): @@ -59,9 +55,7 @@ async def authentication_by_api_key(self): from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel self.logger.info("Instantiate a FaceClient using an api key") - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.DEFAULT_IMAGE_FILE) result = await face_client.detect( helpers.read_file_content(sample_file_path), diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_detection.py b/sdk/face/azure-ai-vision-face/samples/sample_face_detection.py index 5f010bdaaa4ee..d4298a56bea5f 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_detection.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_detection.py @@ -36,12 +36,8 @@ class DetectFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_detection") def detect(self): @@ -54,9 +50,7 @@ def detect(self): FaceAttributeTypeRecognition04, ) - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.IMAGE_DETECTION_5) result = face_client.detect( helpers.read_file_content(sample_file_path), @@ -88,9 +82,7 @@ def detect_from_url(self): FaceAttributeTypeDetection01, ) - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_url = TestImages.DEFAULT_IMAGE_URL result = face_client.detect_from_url( url=sample_url, diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_detection_async.py b/sdk/face/azure-ai-vision-face/samples/sample_face_detection_async.py index 71fe86f1f97a5..890fd2a4feb88 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_detection_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_detection_async.py @@ -37,12 +37,8 @@ class DetectFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_detection_async") async def detect(self): @@ -55,9 +51,7 @@ async def detect(self): FaceAttributeTypeRecognition04, ) - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.IMAGE_DETECTION_5) result = await face_client.detect( helpers.read_file_content(sample_file_path), @@ -89,9 +83,7 @@ async def detect_from_url(self): FaceAttributeTypeDetection01, ) - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_url = TestImages.DEFAULT_IMAGE_URL result = await face_client.detect_from_url( url=sample_url, diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_grouping.py b/sdk/face/azure-ai-vision-face/samples/sample_face_grouping.py index 83a88f0242e89..ac4e538046ef9 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_grouping.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_grouping.py @@ -36,12 +36,8 @@ class GroupFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_grouping") def group(self): @@ -49,9 +45,7 @@ def group(self): from azure.ai.vision.face import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.IMAGE_NINE_FACES) detect_result = face_client.detect( helpers.read_file_content(sample_file_path), @@ -61,9 +55,7 @@ def group(self): ) face_ids = [str(face.face_id) for face in detect_result] - self.logger.info( - f"Detect {len(face_ids)} faces from the file '{sample_file_path}': {face_ids}" - ) + self.logger.info(f"Detect {len(face_ids)} faces from the file '{sample_file_path}': {face_ids}") group_result = face_client.group(face_ids=face_ids) self.logger.info(f"Group result: {beautify_json(group_result.as_dict())}") diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_grouping_async.py b/sdk/face/azure-ai-vision-face/samples/sample_face_grouping_async.py index b7909a60aa780..2adae18a8c135 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_grouping_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_grouping_async.py @@ -37,12 +37,8 @@ class GroupFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_grouping_async") async def group(self): @@ -50,9 +46,7 @@ async def group(self): from azure.ai.vision.face.aio import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: sample_file_path = helpers.get_image_path(TestImages.IMAGE_NINE_FACES) detect_result = await face_client.detect( helpers.read_file_content(sample_file_path), @@ -62,9 +56,7 @@ async def group(self): ) face_ids = [str(face.face_id) for face in detect_result] - self.logger.info( - f"Detect {len(face_ids)} faces from the file '{sample_file_path}': {face_ids}" - ) + self.logger.info(f"Detect {len(face_ids)} faces from the file '{sample_file_path}': {face_ids}") group_result = await face_client.group(face_ids=face_ids) self.logger.info(f"Group result: {beautify_json(group_result.as_dict())}") diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection.py b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection.py index 5901c6f8c11e0..e633fdc51f721 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection.py @@ -41,12 +41,8 @@ class DetectLiveness: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_liveness_detection") def wait_for_liveness_check_request(self): @@ -63,9 +59,7 @@ def wait_for_liveness_session_complete(self): "Please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness" " and use the mobile client SDK to perform liveness detection on your mobile application." ) - input( - "Press any key to continue when you complete these steps to run sample to get session results ..." - ) + input("Press any key to continue when you complete these steps to run sample to get session results ...") pass def livenessSession(self): @@ -79,9 +73,7 @@ def livenessSession(self): LivenessOperationMode, ) - with FaceSessionClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_session_client: + with FaceSessionClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_session_client: # 1. Wait for liveness check request self.wait_for_liveness_check_request() @@ -110,17 +102,13 @@ def livenessSession(self): # 8. Query for the liveness detection result as the session is completed. self.logger.info("Get the liveness detection result.") - liveness_result = face_session_client.get_liveness_session_result( - created_session.session_id - ) + liveness_result = face_session_client.get_liveness_session_result(created_session.session_id) self.logger.info(f"Result: {beautify_json(liveness_result.as_dict())}") # Furthermore, you can query all request and response for this sessions, and list all sessions you have by # calling `get_liveness_session_audit_entries` and `get_liveness_sessions`. self.logger.info("Get the audit entries of this session.") - audit_entries = face_session_client.get_liveness_session_audit_entries( - created_session.session_id - ) + audit_entries = face_session_client.get_liveness_session_audit_entries(created_session.session_id) for idx, entry in enumerate(audit_entries): self.logger.info(f"----- Audit entries: #{idx+1}-----") self.logger.info(f"Entry: {beautify_json(entry.as_dict())}") diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_async.py b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_async.py index 375d74ae20e8f..cc8e0d301103f 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_async.py @@ -42,12 +42,8 @@ class DetectLiveness: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_liveness_detection_async") async def wait_for_liveness_check_request(self): @@ -64,9 +60,7 @@ async def wait_for_liveness_session_complete(self): "Please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness" " and use the mobile client SDK to perform liveness detection on your mobile application." ) - input( - "Press any key to continue when you complete these steps to run sample to get session results ..." - ) + input("Press any key to continue when you complete these steps to run sample to get session results ...") pass async def livenessSession(self): @@ -111,19 +105,13 @@ async def livenessSession(self): # 8. Query for the liveness detection result as the session is completed. self.logger.info("Get the liveness detection result.") - liveness_result = await face_session_client.get_liveness_session_result( - created_session.session_id - ) + liveness_result = await face_session_client.get_liveness_session_result(created_session.session_id) self.logger.info(f"Result: {beautify_json(liveness_result.as_dict())}") # Furthermore, you can query all request and response for this sessions, and list all sessions you have by # calling `get_liveness_session_audit_entries` and `get_liveness_sessions`. self.logger.info("Get the audit entries of this session.") - audit_entries = ( - await face_session_client.get_liveness_session_audit_entries( - created_session.session_id - ) - ) + audit_entries = await face_session_client.get_liveness_session_audit_entries(created_session.session_id) for idx, entry in enumerate(audit_entries): self.logger.info(f"----- Audit entries: #{idx+1}-----") self.logger.info(f"Entry: {beautify_json(entry.as_dict())}") @@ -136,9 +124,7 @@ async def livenessSession(self): # Clean up: delete the session self.logger.info("Delete the session.") - await face_session_client.delete_liveness_session( - created_session.session_id - ) + await face_session_client.delete_liveness_session(created_session.session_id) async def main(): diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification.py b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification.py index c9634f61bf00d..3b8396d31b510 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification.py @@ -44,12 +44,8 @@ class DetectLivenessWithVerify: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_face_liveness_detection_with_verification") def wait_for_liveness_check_request(self): @@ -66,9 +62,7 @@ def wait_for_liveness_session_complete(self): "Please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness" " and use the mobile client SDK to perform liveness detection on your mobile application." ) - input( - "Press any key to continue when you complete these steps to run sample to get session results ..." - ) + input("Press any key to continue when you complete these steps to run sample to get session results ...") pass def livenessSessionWithVerify(self): @@ -82,20 +76,14 @@ def livenessSessionWithVerify(self): LivenessOperationMode, ) - with FaceSessionClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_session_client: + with FaceSessionClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_session_client: # 1. Wait for liveness check request self.wait_for_liveness_check_request() # 2. Create a session with verify image. - verify_image_file_path = helpers.get_image_path( - TestImages.DEFAULT_IMAGE_FILE - ) + verify_image_file_path = helpers.get_image_path(TestImages.DEFAULT_IMAGE_FILE) - self.logger.info( - "Create a new liveness with verify session with verify image." - ) + self.logger.info("Create a new liveness with verify session with verify image.") created_session = face_session_client.create_liveness_with_verify_session( CreateLivenessSessionContent( liveness_operation_mode=LivenessOperationMode.PASSIVE, @@ -120,20 +108,14 @@ def livenessSessionWithVerify(self): # 8. Query for the liveness detection result as the session is completed. self.logger.info("Get the liveness detection result.") - liveness_result = ( - face_session_client.get_liveness_with_verify_session_result( - created_session.session_id - ) - ) + liveness_result = face_session_client.get_liveness_with_verify_session_result(created_session.session_id) self.logger.info(f"Result: {beautify_json(liveness_result.as_dict())}") # Furthermore, you can query all request and response for this sessions, and list all sessions you have by # calling `get_liveness_session_audit_entries` and `get_liveness_sessions`. self.logger.info("Get the audit entries of this session.") - audit_entries = ( - face_session_client.get_liveness_with_verify_session_audit_entries( - created_session.session_id - ) + audit_entries = face_session_client.get_liveness_with_verify_session_audit_entries( + created_session.session_id ) for idx, entry in enumerate(audit_entries): self.logger.info(f"----- Audit entries: #{idx+1}-----") @@ -147,9 +129,7 @@ def livenessSessionWithVerify(self): # Clean up: Delete the session self.logger.info("Delete the session.") - face_session_client.delete_liveness_with_verify_session( - created_session.session_id - ) + face_session_client.delete_liveness_with_verify_session(created_session.session_id) if __name__ == "__main__": diff --git a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification_async.py b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification_async.py index 14376aca0fc4d..00861e0a05f0f 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification_async.py @@ -45,15 +45,9 @@ class DetectLivenessWithVerify: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) - self.logger = get_logger( - "sample_face_liveness_detection_with_verification_async" - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) + self.logger = get_logger("sample_face_liveness_detection_with_verification_async") async def wait_for_liveness_check_request(self): # The logic to wait for liveness check request from mobile application. @@ -69,9 +63,7 @@ async def wait_for_liveness_session_complete(self): "Please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/tutorials/liveness" " and use the mobile client SDK to perform liveness detection on your mobile application." ) - input( - "Press any key to continue when you complete these steps to run sample to get session results ..." - ) + input("Press any key to continue when you complete these steps to run sample to get session results ...") pass async def livenessSessionWithVerify(self): @@ -92,13 +84,9 @@ async def livenessSessionWithVerify(self): await self.wait_for_liveness_check_request() # 2. Create a session with verify image. - verify_image_file_path = helpers.get_image_path( - TestImages.DEFAULT_IMAGE_FILE - ) + verify_image_file_path = helpers.get_image_path(TestImages.DEFAULT_IMAGE_FILE) - self.logger.info( - "Create a new liveness with verify session with verify image." - ) + self.logger.info("Create a new liveness with verify session with verify image.") created_session = await face_session_client.create_liveness_with_verify_session( CreateLivenessSessionContent( liveness_operation_mode=LivenessOperationMode.PASSIVE, @@ -123,10 +111,8 @@ async def livenessSessionWithVerify(self): # 8. Query for the liveness detection result as the session is completed. self.logger.info("Get the liveness detection result.") - liveness_result = ( - await face_session_client.get_liveness_with_verify_session_result( - created_session.session_id - ) + liveness_result = await face_session_client.get_liveness_with_verify_session_result( + created_session.session_id ) self.logger.info(f"Result: {beautify_json(liveness_result.as_dict())}") @@ -148,9 +134,7 @@ async def livenessSessionWithVerify(self): # Clean up: Delete the session self.logger.info("Delete the session.") - await face_session_client.delete_liveness_with_verify_session( - created_session.session_id - ) + await face_session_client.delete_liveness_with_verify_session(created_session.session_id) async def main(): diff --git a/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces.py b/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces.py index cd46330c89dff..a1c56f333d931 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces.py @@ -36,12 +36,8 @@ class FindSimilarFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_findsimilar_faces") def find_similar_from_face_ids(self): @@ -49,9 +45,7 @@ def find_similar_from_face_ids(self): from azure.ai.vision.face import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: # Detect faces from 'IMAGE_NINE_FACES' nine_faces_file_path = helpers.get_image_path(TestImages.IMAGE_NINE_FACES) detect_result1 = face_client.detect( @@ -62,14 +56,10 @@ def find_similar_from_face_ids(self): ) face_ids = [str(face.face_id) for face in detect_result1] - self.logger.info( - f"Detect {len(face_ids)} faces from the file '{nine_faces_file_path}': {face_ids}" - ) + self.logger.info(f"Detect {len(face_ids)} faces from the file '{nine_faces_file_path}': {face_ids}") # Detect face from 'IMAGE_FINDSIMILAR' - find_similar_file_path = helpers.get_image_path( - TestImages.IMAGE_FINDSIMILAR - ) + find_similar_file_path = helpers.get_image_path(TestImages.IMAGE_FINDSIMILAR) detect_result2 = face_client.detect( helpers.read_file_content(find_similar_file_path), detection_model=FaceDetectionModel.DETECTION_03, @@ -79,15 +69,11 @@ def find_similar_from_face_ids(self): assert len(detect_result2) == 1 face_id = str(detect_result2[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{find_similar_file_path}': {face_id}" - ) + self.logger.info(f"Detect 1 face from the file '{find_similar_file_path}': {face_id}") # Call Find Similar # The default find similar mode is MATCH_PERSON - find_similar_result1 = face_client.find_similar( - face_id=face_id, face_ids=face_ids - ) + find_similar_result1 = face_client.find_similar(face_id=face_id, face_ids=face_ids) self.logger.info("Find Similar with matchPerson mode:") for r in find_similar_result1: self.logger.info(f"{beautify_json(r.as_dict())}") diff --git a/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces_async.py b/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces_async.py index 579ea44cd78ef..5c7b23afb21a3 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces_async.py @@ -37,12 +37,8 @@ class FindSimilarFaces: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_findsimilar_faces_async") async def find_similar_from_face_ids(self): @@ -50,9 +46,7 @@ async def find_similar_from_face_ids(self): from azure.ai.vision.face.aio import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: # Detect faces from 'IMAGE_NINE_FACES' nine_faces_file_path = helpers.get_image_path(TestImages.IMAGE_NINE_FACES) detect_result1 = await face_client.detect( @@ -63,14 +57,10 @@ async def find_similar_from_face_ids(self): ) face_ids = [str(face.face_id) for face in detect_result1] - self.logger.info( - f"Detect {len(face_ids)} faces from the file '{nine_faces_file_path}': {face_ids}" - ) + self.logger.info(f"Detect {len(face_ids)} faces from the file '{nine_faces_file_path}': {face_ids}") # Detect face from 'IMAGE_FINDSIMILAR' - find_similar_file_path = helpers.get_image_path( - TestImages.IMAGE_FINDSIMILAR - ) + find_similar_file_path = helpers.get_image_path(TestImages.IMAGE_FINDSIMILAR) detect_result2 = await face_client.detect( helpers.read_file_content(find_similar_file_path), detection_model=FaceDetectionModel.DETECTION_03, @@ -80,15 +70,11 @@ async def find_similar_from_face_ids(self): assert len(detect_result2) == 1 face_id = str(detect_result2[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{find_similar_file_path}': {face_id}" - ) + self.logger.info(f"Detect 1 face from the file '{find_similar_file_path}': {face_id}") # Call Find Similar # The default find similar mode is MATCH_PERSON - find_similar_result1 = await face_client.find_similar( - face_id=face_id, face_ids=face_ids - ) + find_similar_result1 = await face_client.find_similar(face_id=face_id, face_ids=face_ids) self.logger.info("Find Similar with matchPerson mode:") for r in find_similar_result1: self.logger.info(f"{beautify_json(r.as_dict())}") diff --git a/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification.py b/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification.py index e0b275137b4fb..8770f7c093dda 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification.py @@ -36,12 +36,8 @@ class StatelessFaceVerification: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_stateless_face_verification") def verify_face_to_face(self): @@ -49,9 +45,7 @@ def verify_face_to_face(self): from azure.ai.vision.face import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: dad_picture1 = helpers.get_image_path(TestImages.IMAGE_FAMILY_1_DAD_1) detect_result1 = face_client.detect( helpers.read_file_content(dad_picture1), @@ -61,9 +55,7 @@ def verify_face_to_face(self): ) assert len(detect_result1) == 1 dad_face_id1 = str(detect_result1[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{dad_picture1}': {dad_face_id1}" - ) + self.logger.info(f"Detect 1 face from the file '{dad_picture1}': {dad_face_id1}") dad_picture2 = helpers.get_image_path(TestImages.IMAGE_FAMILY_1_DAD_2) detect_result2 = face_client.detect( @@ -74,14 +66,10 @@ def verify_face_to_face(self): ) assert len(detect_result2) == 1 dad_face_id2 = str(detect_result2[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{dad_picture2}': {dad_face_id2}" - ) + self.logger.info(f"Detect 1 face from the file '{dad_picture2}': {dad_face_id2}") # Call Verify to check if dad_face_id1 and dad_face_id2 belong to the same person. - verify_result1 = face_client.verify_face_to_face( - face_id1=dad_face_id1, face_id2=dad_face_id2 - ) + verify_result1 = face_client.verify_face_to_face(face_id1=dad_face_id1, face_id2=dad_face_id2) self.logger.info( f"Verify if the faces in '{TestImages.IMAGE_FAMILY_1_DAD_1}' and '{TestImages.IMAGE_FAMILY_1_DAD_2}'" f" belongs to the same person." @@ -97,14 +85,10 @@ def verify_face_to_face(self): ) assert len(detect_result3) == 1 man_face_id = str(detect_result3[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{man_picture}': {man_face_id}" - ) + self.logger.info(f"Detect 1 face from the file '{man_picture}': {man_face_id}") # Call Verify to check if dad_face_id1 and man_face_id belong to the same person. - verify_result2 = face_client.verify_face_to_face( - face_id1=dad_face_id1, face_id2=man_face_id - ) + verify_result2 = face_client.verify_face_to_face(face_id1=dad_face_id1, face_id2=man_face_id) self.logger.info( f"Verify if the faces in '{TestImages.IMAGE_FAMILY_1_DAD_1}' and '{TestImages.IMAGE_FAMILY_3_Man_1}'" f" belongs to the same person." diff --git a/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification_async.py b/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification_async.py index 07b9471b7d745..9b4c67ff76bf8 100644 --- a/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification_async.py +++ b/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification_async.py @@ -37,12 +37,8 @@ class StatelessFaceVerification: def __init__(self): load_dotenv(find_dotenv()) - self.endpoint = os.getenv( - CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT - ) - self.key = os.getenv( - CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY - ) + self.endpoint = os.getenv(CONFIGURATION_NAME_FACE_API_ENDPOINT, DEFAULT_FACE_API_ENDPOINT) + self.key = os.getenv(CONFIGURATION_NAME_FACE_API_ACCOUNT_KEY, DEFAULT_FACE_API_ACCOUNT_KEY) self.logger = get_logger("sample_stateless_face_verification_async") async def verify_face_to_face(self): @@ -50,9 +46,7 @@ async def verify_face_to_face(self): from azure.ai.vision.face.aio import FaceClient from azure.ai.vision.face.models import FaceDetectionModel, FaceRecognitionModel - async with FaceClient( - endpoint=self.endpoint, credential=AzureKeyCredential(self.key) - ) as face_client: + async with FaceClient(endpoint=self.endpoint, credential=AzureKeyCredential(self.key)) as face_client: dad_picture1 = helpers.get_image_path(TestImages.IMAGE_FAMILY_1_DAD_1) detect_result1 = await face_client.detect( helpers.read_file_content(dad_picture1), @@ -62,9 +56,7 @@ async def verify_face_to_face(self): ) assert len(detect_result1) == 1 dad_face_id1 = str(detect_result1[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{dad_picture1}': {dad_face_id1}" - ) + self.logger.info(f"Detect 1 face from the file '{dad_picture1}': {dad_face_id1}") dad_picture2 = helpers.get_image_path(TestImages.IMAGE_FAMILY_1_DAD_2) detect_result2 = await face_client.detect( @@ -75,14 +67,10 @@ async def verify_face_to_face(self): ) assert len(detect_result2) == 1 dad_face_id2 = str(detect_result2[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{dad_picture2}': {dad_face_id2}" - ) + self.logger.info(f"Detect 1 face from the file '{dad_picture2}': {dad_face_id2}") # Call Verify to check if dad_face_id1 and dad_face_id2 belong to the same person. - verify_result1 = await face_client.verify_face_to_face( - face_id1=dad_face_id1, face_id2=dad_face_id2 - ) + verify_result1 = await face_client.verify_face_to_face(face_id1=dad_face_id1, face_id2=dad_face_id2) self.logger.info( f"Verify if the faces in '{TestImages.IMAGE_FAMILY_1_DAD_1}' and '{TestImages.IMAGE_FAMILY_1_DAD_2}'" f" belongs to the same person." @@ -98,14 +86,10 @@ async def verify_face_to_face(self): ) assert len(detect_result3) == 1 man_face_id = str(detect_result3[0].face_id) - self.logger.info( - f"Detect 1 face from the file '{man_picture}': {man_face_id}" - ) + self.logger.info(f"Detect 1 face from the file '{man_picture}': {man_face_id}") # Call Verify to check if dad_face_id1 and man_face_id belong to the same person. - verify_result2 = await face_client.verify_face_to_face( - face_id1=dad_face_id1, face_id2=man_face_id - ) + verify_result2 = await face_client.verify_face_to_face(face_id1=dad_face_id1, face_id2=man_face_id) self.logger.info( f"Verify if the faces in '{TestImages.IMAGE_FAMILY_1_DAD_1}' and '{TestImages.IMAGE_FAMILY_3_Man_1}'" f" belongs to the same person." diff --git a/sdk/face/azure-ai-vision-face/samples/shared/helpers.py b/sdk/face/azure-ai-vision-face/samples/shared/helpers.py index 40def24e72843..b3b6e1578271f 100644 --- a/sdk/face/azure-ai-vision-face/samples/shared/helpers.py +++ b/sdk/face/azure-ai-vision-face/samples/shared/helpers.py @@ -21,11 +21,7 @@ def get_logger(name): # create console handler handler = logging.StreamHandler() - handler.setFormatter( - logging.Formatter( - fmt="%(asctime)s %(levelname)s %(message)s", datefmt="%Y-%m-%d %H:%M:%S" - ) - ) + handler.setFormatter(logging.Formatter(fmt="%(asctime)s %(levelname)s %(message)s", datefmt="%Y-%m-%d %H:%M:%S")) # create Logger logger = logging.getLogger(name) @@ -42,9 +38,7 @@ def beautify_json(obj: typing.Dict[str, typing.Any]): def get_image_path(image_file_name: str): from .constants import TestImages - return Path(__file__).resolve().parent / ( - TestImages.IMAGE_PARENT_FOLDER + "/" + image_file_name - ) + return Path(__file__).resolve().parent / (TestImages.IMAGE_PARENT_FOLDER + "/" + image_file_name) def read_file_content(file_path: Path): diff --git a/sdk/face/azure-ai-vision-face/tests/_shared/asserter.py b/sdk/face/azure-ai-vision-face/tests/_shared/asserter.py index 40a4d87f02bf4..e0f5722d8c851 100644 --- a/sdk/face/azure-ai-vision-face/tests/_shared/asserter.py +++ b/sdk/face/azure-ai-vision-face/tests/_shared/asserter.py @@ -32,9 +32,7 @@ def _assert_liveness_with_verify_image_not_empty( verify_image: models.LivenessWithVerifyImage, ): _assert_face_rectangle_not_empty(verify_image.face_rectangle) - assert isinstance( - verify_image.quality_for_recognition, models.QualityForRecognition - ) + assert isinstance(verify_image.quality_for_recognition, models.QualityForRecognition) def _assert_liveness_with_verify_outputs_not_empty( @@ -45,9 +43,7 @@ def _assert_liveness_with_verify_outputs_not_empty( assert output.is_identical is not None -def _assert_liveness_response_body_not_empty( - body: models.LivenessResponseBody, is_liveness_with_verify: bool = True -): +def _assert_liveness_response_body_not_empty(body: models.LivenessResponseBody, is_liveness_with_verify: bool = True): assert body.liveness_decision in models.FaceLivenessDecision _assert_liveness_outputs_target_not_empty(body.target) assert body.model_version_used in models.LivenessModel @@ -67,9 +63,7 @@ def _assert_session_audit_entry_request_info_not_empty( def _assert_session_audit_entry_response_info_not_empty( response: models.AuditLivenessResponseInfo, is_liveness_with_verify: bool = True ): - _assert_liveness_response_body_not_empty( - response.body, is_liveness_with_verify=is_liveness_with_verify - ) + _assert_liveness_response_body_not_empty(response.body, is_liveness_with_verify=is_liveness_with_verify) assert response.status_code > 0 assert response.latency_in_milliseconds > 0 diff --git a/sdk/face/azure-ai-vision-face/tests/_shared/helpers.py b/sdk/face/azure-ai-vision-face/tests/_shared/helpers.py index 81da59c9513d7..f9665f11b2be0 100644 --- a/sdk/face/azure-ai-vision-face/tests/_shared/helpers.py +++ b/sdk/face/azure-ai-vision-face/tests/_shared/helpers.py @@ -24,9 +24,7 @@ def get_account_key(**kwargs): def get_image_path(image_file_name: str): from .constants import TestImages - return Path(__file__).resolve().parent / ( - TestImages.IMAGE_PARENT_FOLDER + "/" + image_file_name - ) + return Path(__file__).resolve().parent / (TestImages.IMAGE_PARENT_FOLDER + "/" + image_file_name) def read_file_content(file_path: Path): diff --git a/sdk/face/azure-ai-vision-face/tests/_shared/testcase.py b/sdk/face/azure-ai-vision-face/tests/_shared/testcase.py index b6853948d712c..51c379740a848 100644 --- a/sdk/face/azure-ai-vision-face/tests/_shared/testcase.py +++ b/sdk/face/azure-ai-vision-face/tests/_shared/testcase.py @@ -14,9 +14,7 @@ class FaceClientTestCase: def _set_up(self, endpoint, account_key) -> None: - self._client = FaceClient( - endpoint=endpoint, credential=AzureKeyCredential(account_key) - ) + self._client = FaceClient(endpoint=endpoint, credential=AzureKeyCredential(account_key)) def _tear_down(self) -> None: self._client.close() @@ -24,9 +22,7 @@ def _tear_down(self) -> None: class FaceSessionClientTestCase: def _set_up(self, endpoint, account_key) -> None: - self._client = FaceSessionClient( - endpoint=endpoint, credential=AzureKeyCredential(account_key) - ) + self._client = FaceSessionClient(endpoint=endpoint, credential=AzureKeyCredential(account_key)) def _tear_down(self) -> None: self._client.close() diff --git a/sdk/face/azure-ai-vision-face/tests/preparers.py b/sdk/face/azure-ai-vision-face/tests/preparers.py index 95d84870cf6b9..911a227a74ce0 100644 --- a/sdk/face/azure-ai-vision-face/tests/preparers.py +++ b/sdk/face/azure-ai-vision-face/tests/preparers.py @@ -31,8 +31,7 @@ def create_resource(self, name, **kwargs): self._client = self._client_cls(endpoint, AzureKeyCredential(account_key)) env_name = ( self._client_kwargs["client_env_name"] - if self._client_kwargs is not None - and "client_env_name" in self._client_kwargs + if self._client_kwargs is not None and "client_env_name" in self._client_kwargs else "client" ) @@ -58,6 +57,4 @@ def remove_resource(self, name, **kwargs): # Async client AsyncFaceClientPreparer = functools.partial(ClientPreparer, AsyncClient.FaceClient) -AsyncFaceSessionClientPreparer = functools.partial( - ClientPreparer, AsyncClient.FaceSessionClient -) +AsyncFaceSessionClientPreparer = functools.partial(ClientPreparer, AsyncClient.FaceSessionClient) diff --git a/sdk/face/azure-ai-vision-face/tests/test_liveness_session.py b/sdk/face/azure-ai-vision-face/tests/test_liveness_session.py index 04d18fe370714..14399821f4792 100644 --- a/sdk/face/azure-ai-vision-face/tests/test_liveness_session.py +++ b/sdk/face/azure-ai-vision-face/tests/test_liveness_session.py @@ -30,9 +30,7 @@ class TestLivenessSession(AzureRecordedTestCase): @recorded_by_proxy def test_create_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # Test `create session` operation created_session = client.create_liveness_session( @@ -80,10 +78,7 @@ def test_list_sessions(self, client, **kwargs): created_session_dict[created_session.session_id] = dcid # Sort the dict by key because the `list sessions` operation returns sessions in ascending alphabetical order. - expected_dcid_queue = deque( - value - for _, value in sorted(created_session_dict.items(), key=lambda t: t[0]) - ) + expected_dcid_queue = deque(value for _, value in sorted(created_session_dict.items(), key=lambda t: t[0])) # Test `list sessions` operation result = client.get_liveness_sessions() @@ -107,9 +102,7 @@ def test_list_sessions(self, client, **kwargs): @recorded_by_proxy def test_get_session_result(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e" - ) + recorded_session_id = variables.setdefault("sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e") session = client.get_liveness_session_result(recorded_session_id) assert session.created_date_time is not None @@ -133,9 +126,7 @@ def test_get_session_result(self, client, **kwargs): @recorded_by_proxy def test_get_session_audit_entries(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e" - ) + recorded_session_id = variables.setdefault("sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e") entries = client.get_liveness_session_audit_entries(recorded_session_id) assert len(entries) == 2 @@ -153,9 +144,7 @@ def test_get_session_audit_entries(self, client, **kwargs): @recorded_by_proxy def test_delete_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) created_session = client.create_liveness_session( CreateLivenessSessionContent( diff --git a/sdk/face/azure-ai-vision-face/tests/test_liveness_session_async.py b/sdk/face/azure-ai-vision-face/tests/test_liveness_session_async.py index ac9846ff152b2..ef7b5e5ef0e81 100644 --- a/sdk/face/azure-ai-vision-face/tests/test_liveness_session_async.py +++ b/sdk/face/azure-ai-vision-face/tests/test_liveness_session_async.py @@ -31,9 +31,7 @@ class TestLivenessSessionAsync(AzureRecordedTestCase): @recorded_by_proxy_async async def test_create_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # Test `create session` operation created_session = await client.create_liveness_session( @@ -82,10 +80,7 @@ async def test_list_sessions(self, client, **kwargs): created_session_dict[created_session.session_id] = dcid # Sort the dict by key because the `list sessions` operation returns sessions in ascending alphabetical order. - expected_dcid_queue = deque( - value - for _, value in sorted(created_session_dict.items(), key=lambda t: t[0]) - ) + expected_dcid_queue = deque(value for _, value in sorted(created_session_dict.items(), key=lambda t: t[0])) # Test `list sessions` operation result = await client.get_liveness_sessions() @@ -110,9 +105,7 @@ async def test_list_sessions(self, client, **kwargs): @recorded_by_proxy_async async def test_get_session_result(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e" - ) + recorded_session_id = variables.setdefault("sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e") session = await client.get_liveness_session_result(recorded_session_id) assert session.created_date_time is not None @@ -137,9 +130,7 @@ async def test_get_session_result(self, client, **kwargs): @recorded_by_proxy_async async def test_get_session_audit_entries(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e" - ) + recorded_session_id = variables.setdefault("sessionId", "5f8e0996-4ef0-4142-9b5d-e42fa5748a7e") entries = await client.get_liveness_session_audit_entries(recorded_session_id) assert len(entries) == 2 @@ -158,9 +149,7 @@ async def test_get_session_audit_entries(self, client, **kwargs): @recorded_by_proxy_async async def test_delete_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) created_session = await client.create_liveness_session( CreateLivenessSessionContent( diff --git a/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session.py b/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session.py index 1d23311e4c860..7699f0ccfff1d 100644 --- a/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session.py +++ b/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session.py @@ -33,9 +33,7 @@ class TestLivenessWithVerifySession(AzureRecordedTestCase): @recorded_by_proxy def test_create_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # Test `create session` operation created_session = client.create_liveness_with_verify_session( @@ -64,9 +62,7 @@ def test_create_session(self, client, **kwargs): @recorded_by_proxy def test_create_session_with_verify_image(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # verify_image sample_file_path = helpers.get_image_path(TestImages.IMAGE_DETECTION_1) @@ -121,10 +117,7 @@ def test_list_sessions(self, client, **kwargs): created_session_dict[created_session.session_id] = dcid # Sort the dict by key because the `list sessions` operation returns sessions in ascending alphabetical order. - expected_dcid_queue = deque( - value - for _, value in sorted(created_session_dict.items(), key=lambda t: t[0]) - ) + expected_dcid_queue = deque(value for _, value in sorted(created_session_dict.items(), key=lambda t: t[0])) # Test `list sessions` operation result = client.get_liveness_with_verify_sessions() @@ -148,9 +141,7 @@ def test_list_sessions(self, client, **kwargs): @recorded_by_proxy def test_get_session_result(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854" - ) + recorded_session_id = variables.setdefault("sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854") session = client.get_liveness_with_verify_session_result(recorded_session_id) assert session.created_date_time is not None @@ -174,13 +165,9 @@ def test_get_session_result(self, client, **kwargs): @recorded_by_proxy def test_get_session_audit_entries(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854" - ) + recorded_session_id = variables.setdefault("sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854") - entries = client.get_liveness_with_verify_session_audit_entries( - recorded_session_id - ) + entries = client.get_liveness_with_verify_session_audit_entries(recorded_session_id) assert len(entries) == 2 for entry in entries: _assert_liveness_session_audit_entry_is_valid( @@ -196,9 +183,7 @@ def test_get_session_audit_entries(self, client, **kwargs): @recorded_by_proxy def test_delete_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) created_session = client.create_liveness_with_verify_session( CreateLivenessSessionContent( diff --git a/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session_async.py b/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session_async.py index 4e05b2a7a4cb9..d3933ea9ef4ac 100644 --- a/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session_async.py +++ b/sdk/face/azure-ai-vision-face/tests/test_liveness_with_verify_session_async.py @@ -34,9 +34,7 @@ class TestLivenessWithVerifySessionAsync(AzureRecordedTestCase): @recorded_by_proxy_async async def test_create_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # Test `create session` operation created_session = await client.create_liveness_with_verify_session( @@ -66,9 +64,7 @@ async def test_create_session(self, client, **kwargs): @recorded_by_proxy_async async def test_create_session_with_verify_image(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) # verify_image sample_file_path = helpers.get_image_path(TestImages.IMAGE_DETECTION_1) @@ -124,10 +120,7 @@ async def test_list_sessions(self, client, **kwargs): created_session_dict[created_session.session_id] = dcid # Sort the dict by key because the `list sessions` operation returns sessions in ascending alphabetical order. - expected_dcid_queue = deque( - value - for _, value in sorted(created_session_dict.items(), key=lambda t: t[0]) - ) + expected_dcid_queue = deque(value for _, value in sorted(created_session_dict.items(), key=lambda t: t[0])) # Test `list sessions` operation result = await client.get_liveness_with_verify_sessions() @@ -152,13 +145,9 @@ async def test_list_sessions(self, client, **kwargs): @recorded_by_proxy_async async def test_get_session_result(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854" - ) + recorded_session_id = variables.setdefault("sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854") - session = await client.get_liveness_with_verify_session_result( - recorded_session_id - ) + session = await client.get_liveness_with_verify_session_result(recorded_session_id) assert session.created_date_time is not None assert session.session_start_date_time is not None assert isinstance(session.session_expired, bool) @@ -181,13 +170,9 @@ async def test_get_session_result(self, client, **kwargs): @recorded_by_proxy_async async def test_get_session_audit_entries(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_session_id = variables.setdefault( - "sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854" - ) + recorded_session_id = variables.setdefault("sessionId", "1b79f44d-d8e0-4652-8f2d-637c4205d854") - entries = await client.get_liveness_with_verify_session_audit_entries( - recorded_session_id - ) + entries = await client.get_liveness_with_verify_session_audit_entries(recorded_session_id) assert len(entries) == 2 for entry in entries: _assert_liveness_session_audit_entry_is_valid( @@ -204,9 +189,7 @@ async def test_get_session_audit_entries(self, client, **kwargs): @recorded_by_proxy_async async def test_delete_session(self, client, **kwargs): variables = kwargs.pop("variables", {}) - recorded_device_correlation_id = variables.setdefault( - "deviceCorrelationId", str(uuid.uuid4()) - ) + recorded_device_correlation_id = variables.setdefault("deviceCorrelationId", str(uuid.uuid4())) created_session = await client.create_liveness_with_verify_session( CreateLivenessSessionContent( diff --git a/sdk/face/azure-ai-vision-face/tsp-location.yaml b/sdk/face/azure-ai-vision-face/tsp-location.yaml index 272d2f0e253b6..fa0239f8cca8b 100644 --- a/sdk/face/azure-ai-vision-face/tsp-location.yaml +++ b/sdk/face/azure-ai-vision-face/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/ai/Face -commit: 1d2253d1e221541cf05ae5d0dd95bd28c0846238 +commit: 228acac22c34fa19cd629ba2df005822ab8ba959 repo: Azure/azure-rest-api-specs additionalDirectories: diff --git a/sdk/programmableconnectivity/azure-programmableconnectivity/CHANGELOG.md b/sdk/programmableconnectivity/azure-programmableconnectivity/CHANGELOG.md new file mode 100644 index 0000000000000..628743d283a92 --- /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 0000000000000..63447fd8bbbf7 --- /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 0000000000000..3882ed1ad8100 --- /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 0000000000000..2f38768c498e0 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/README.md @@ -0,0 +1,80 @@ + + +# Azure Programmableconnectivity client library for Python + + +## Getting started + +### Install 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 0000000000000..af101af108d92 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/_meta.json @@ -0,0 +1,7 @@ +{ + "commit": "228acac22c34fa19cd629ba2df005822ab8ba959", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/programmableconnectivity/Azure.ProgrammableConnectivity", + "@azure-tools/typespec-python": "0.24.3", + "@autorest/python": "6.14.3" +} \ 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 0000000000000..d55ccad1f573f --- /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 0000000000000..7050026a813f8 --- /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 0000000000000..0e41882d944b8 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_client.py @@ -0,0 +1,122 @@ +# 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 typing_extensions import Self + +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 used to authenticate requests to the service. 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"), + } + + 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) -> Self: + 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 0000000000000..20f5c8981891f --- /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 used to authenticate requests to the service. 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 0000000000000..43fd8c7e9b1b4 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_model_base.py @@ -0,0 +1,888 @@ +# 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 copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +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 = 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 _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +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) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + 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()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +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 + + 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 len(annotation.__args__) <= 2: # 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 + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + 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_annotations(annotation.__args__) # pyright: ignore + ] + + 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 + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + 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, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + 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 + visibility: typing.Optional[typing.List[str]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility) 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 0000000000000..f7dd32510333d --- /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 0000000000000..8139854b97bb8 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_serialization.py @@ -0,0 +1,2000 @@ +# -------------------------------------------------------------------------- +# +# 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 + elif content_type.startswith("text/"): + return data_as_str + 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 or data is CoreNull: + 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/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py similarity index 54% rename from sdk/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py rename to sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py index 5b396cd202e83..be71c81bd2821 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/__init__.py +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/_version.py @@ -1,5 +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. +# 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 0000000000000..ae6647e003e51 --- /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 0000000000000..fe507fcefd8a3 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/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 typing_extensions import Self + +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 used to authenticate requests to the service. 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"), + } + + 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) -> Self: + 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 0000000000000..4b0b912675f7b --- /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 used to authenticate requests to the service. 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 0000000000000..f7dd32510333d --- /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 0000000000000..438712907b24f --- /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 0000000000000..55e35492a09de --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/aio/operations/_operations.py @@ -0,0 +1,1292 @@ +# 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, Type, 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: + """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: Body parameter. 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, + "device": { + "ipv4Address": { + "ipv4": "str", + "port": 0 + }, + "ipv6Address": { + "ipv6": "str", + "port": 0 + }, + "networkAccessIdentifier": "str", + "phoneNumber": "str" + }, + "latitude": 0.0, + "longitude": 0.0, + "networkIdentifier": { + "identifier": "str", + "identifierType": "str" + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace_async + async def verify( + self, + body: Union[_models.DeviceLocationVerificationContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **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: Body parameter. 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, + "device": { + "ipv4Address": { + "ipv4": "str", + "port": 0 + }, + "ipv6Address": { + "ipv6": "str", + "port": 0 + }, + "networkAccessIdentifier": "str", + "phoneNumber": "str" + }, + "latitude": 0.0, + "longitude": 0.0, + "networkIdentifier": { + "identifier": "str", + "identifierType": "str" + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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", + "identifierType": "str" + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" + } + """ + + @overload + async def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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" + } + """ + + @overload + async def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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" + } + """ + + @distributed_trace_async + async def retrieve( + self, body: Union[_models.NetworkIdentifier, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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", + "identifierType": "str" + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "redirectUri": "str", + "hashedPhoneNumber": "str", + "phoneNumber": "str" + } + """ + + @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: Body parameter. 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: Body parameter. 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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "redirectUri": "str", + "hashedPhoneNumber": "str", + "phoneNumber": "str" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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]: + 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: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Body parameter. 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" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace_async + async def verify_with_code( + self, + body: Union[_models.NumberVerificationWithCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Body parameter. 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" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """Provides timestamp of latest SIM swap. + + :param body: Body parameter. 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", + "identifierType": "str" + }, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" + } + """ + + @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: Body parameter. 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" + } + """ + + @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: Body parameter. 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" + } + """ + + @distributed_trace_async + async def retrieve( + self, body: Union[_models.SimSwapRetrievalContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Body parameter. 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", + "identifierType": "str" + }, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "maxAgeHours": 0, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace_async + async def verify( + self, body: Union[_models.SimSwapVerificationContent, JSON, IO[bytes]], *, apc_gateway_id: str, **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: Body parameter. 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", + "identifierType": "str" + }, + "maxAgeHours": 0, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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 0000000000000..f7dd32510333d --- /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 0000000000000..331b8ab932360 --- /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 0000000000000..c55ef12478462 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/models/_models.py @@ -0,0 +1,538 @@ +# 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. + + + :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. + + + :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. + + + :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 apc_code: The code provided by APC in exchange for the operator code. Required. + :vartype apc_code: str + """ + + apc_code: str = rest_field(name="apcCode") + """The code provided by APC in exchange for the operator code. Required.""" + + @overload + def __init__( + self, + *, + apc_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 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 + :ivar redirect_uri: Redirect URI to backend application. Required. + :vartype redirect_uri: 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 '+'.""" + redirect_uri: str = rest_field(name="redirectUri") + """Redirect URI to backend application. Required.""" + + @overload + def __init__( + self, + *, + network_identifier: "_models.NetworkIdentifier", + redirect_uri: 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 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. + + :ivar date: Datetime of most recent swap for SIM. + :vartype date: ~datetime.datetime + """ + + date: Optional[datetime.datetime] = rest_field(format="rfc3339") + """Datetime of most recent swap for SIM.""" + + @overload + def __init__( + self, + *, + date: 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 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. + + + :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 0000000000000..f7dd32510333d --- /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 0000000000000..438712907b24f --- /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 0000000000000..66fcf857aff31 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/azure/programmableconnectivity/operations/_operations.py @@ -0,0 +1,1430 @@ +# 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, Type, 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") + 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, 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") + 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, 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")) + 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") + 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, 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") + 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, 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") + 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, 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") + 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, 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: + """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: Body parameter. 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, + "device": { + "ipv4Address": { + "ipv4": "str", + "port": 0 + }, + "ipv6Address": { + "ipv6": "str", + "port": 0 + }, + "networkAccessIdentifier": "str", + "phoneNumber": "str" + }, + "latitude": 0.0, + "longitude": 0.0, + "networkIdentifier": { + "identifier": "str", + "identifierType": "str" + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace + def verify( + self, + body: Union[_models.DeviceLocationVerificationContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **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: Body parameter. 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, + "device": { + "ipv4Address": { + "ipv4": "str", + "port": 0 + }, + "ipv6Address": { + "ipv6": "str", + "port": 0 + }, + "networkAccessIdentifier": "str", + "phoneNumber": "str" + }, + "latitude": 0.0, + "longitude": 0.0, + "networkIdentifier": { + "identifier": "str", + "identifierType": "str" + } + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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", + "identifierType": "str" + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" + } + """ + + @overload + def retrieve( + self, body: JSON, *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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" + } + """ + + @overload + def retrieve( + self, body: IO[bytes], *, apc_gateway_id: str, content_type: str = "application/json", **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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" + } + """ + + @distributed_trace + def retrieve( + self, body: Union[_models.NetworkIdentifier, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.NetworkRetrievalResult: + """Retrieves the network a given device is on. Returns network in a networkCode format that can be + used for other APIs. + + :param body: Body parameter. 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", + "identifierType": "str" + } + + # response body for status code(s): 200 + response == { + "networkCode": "str" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "redirectUri": "str", + "hashedPhoneNumber": "str", + "phoneNumber": "str" + } + """ + + @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: Body parameter. 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: Body parameter. 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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "redirectUri": "str", + "hashedPhoneNumber": "str", + "phoneNumber": "str" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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]: + 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: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Body parameter. 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" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace + def verify_with_code( + self, + body: Union[_models.NumberVerificationWithCodeContent, JSON, IO[bytes]], + *, + apc_gateway_id: str, + **kwargs: Any + ) -> _models.NumberVerificationResult: + """Verifies the phone number (MSISDN) associated with a device. + + :param body: Body parameter. 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" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """Provides timestamp of latest SIM swap. + + :param body: Body parameter. 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", + "identifierType": "str" + }, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" + } + """ + + @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: Body parameter. 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" + } + """ + + @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: Body parameter. 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" + } + """ + + @distributed_trace + def retrieve( + self, body: Union[_models.SimSwapRetrievalContent, JSON, IO[bytes]], *, apc_gateway_id: str, **kwargs: Any + ) -> _models.SimSwapRetrievalResult: + """Provides timestamp of latest SIM swap. + + :param body: Body parameter. 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", + "identifierType": "str" + }, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "date": "2020-02-20 00:00:00" + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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: + """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: Body parameter. 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", + "identifierType": "str" + }, + "maxAgeHours": 0, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + + @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: Body parameter. 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 + } + """ + + @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: Body parameter. 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 + } + """ + + @distributed_trace + def verify( + self, body: Union[_models.SimSwapVerificationContent, JSON, IO[bytes]], *, apc_gateway_id: str, **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: Body parameter. 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", + "identifierType": "str" + }, + "maxAgeHours": 0, + "phoneNumber": "str" + } + + # response body for status code(s): 200 + response == { + "verificationResult": bool + } + """ + error_map: MutableMapping[int, Type[HttpResponseError]] = { + 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"), + } + _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 0000000000000..f7dd32510333d --- /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 0000000000000..e5aff4f83af86 --- /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 0000000000000..c82827bb56f44 --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/dev_requirements.txt @@ -0,0 +1,4 @@ +-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 0000000000000..e7687fdae93bc --- /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 0000000000000..ed4a074f0b8eb --- /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>=0.6.1", + "azure-core>=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 0000000000000..a35a4cf3a6dbb --- /dev/null +++ b/sdk/programmableconnectivity/azure-programmableconnectivity/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/programmableconnectivity/Azure.ProgrammableConnectivity +commit: 228acac22c34fa19cd629ba2df005822ab8ba959 +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/programmableconnectivity/ci.yml b/sdk/programmableconnectivity/ci.yml new file mode 100644 index 0000000000000..deb7914f63481 --- /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/_meta.json b/sdk/purview/azure-purview-datamap/_meta.json new file mode 100644 index 0000000000000..d3f27d2ec4f0f --- /dev/null +++ b/sdk/purview/azure-purview-datamap/_meta.json @@ -0,0 +1,7 @@ +{ + "commit": "228acac22c34fa19cd629ba2df005822ab8ba959", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/purview/Azure.Analytics.Purview.DataMap", + "@azure-tools/typespec-python": "0.24.3", + "@autorest/python": "6.14.3" +} \ No newline at end of file diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py index 4dac6f59e70ba..1397ce26c20ac 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, TYPE_CHECKING +from typing_extensions import Self from azure.core import PipelineClient from azure.core.pipeline import policies @@ -44,13 +45,14 @@ class DataMapClient: # pylint: disable=client-accepts-api-version-keyword :vartype relationship: azure.purview.datamap.operations.RelationshipOperations :ivar type_definition: TypeDefinitionOperations operations :vartype type_definition: azure.purview.datamap.operations.TypeDefinitionOperations - :param endpoint: Required. + :param endpoint: Purview Data Map Service is a fully managed cloud service whose users can + discover the data sources they need and understand the data sources they find. At the same + time, Data Map helps organizations get more value from their existing investments. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param credential: Credential used to authenticate requests to the service. 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. + :keyword api_version: The API version to use for this operation. Default value is "2023-09-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -106,7 +108,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: 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"), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) @@ -115,7 +117,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "DataMapClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py index 1084d8ba9649d..449432c31576a 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_configuration.py @@ -23,13 +23,14 @@ class DataMapClientConfiguration: # pylint: disable=too-many-instance-attribute Note that all parameters used to create this instance are saved as instance attributes. - :param endpoint: Required. + :param endpoint: Purview Data Map Service is a fully managed cloud service whose users can + discover the data sources they need and understand the data sources they find. At the same + time, Data Map helps organizations get more value from their existing investments. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param credential: Credential used to authenticate requests to the service. 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. + :keyword api_version: The API version to use for this operation. Default value is "2023-09-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ 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 index 1ddc071517d69..43fd8c7e9b1b4 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_model_base.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_model_base.py @@ -6,6 +6,7 @@ # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except +import copy import calendar import decimal import functools @@ -13,7 +14,6 @@ import logging import base64 import re -import copy import typing import enum import email.utils @@ -339,7 +339,7 @@ def _get_model(module_name: str, model_name: str): 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) + self._data = data def __contains__(self, key: typing.Any) -> bool: return key in self._data @@ -378,16 +378,13 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: return default @typing.overload - def pop(self, key: str) -> typing.Any: - ... + def pop(self, key: str) -> typing.Any: ... @typing.overload - def pop(self, key: str, default: _T) -> _T: - ... + 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) -> typing.Any: ... def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: if default is _UNSET: @@ -404,12 +401,10 @@ 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: - ... + 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) -> typing.Any: ... def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: if default is _UNSET: @@ -594,6 +589,64 @@ def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +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) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + 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()} + + +def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: typing.List[typing.Any]) -> typing.List[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 annotation: typing.Any, module: typing.Optional[str], @@ -621,11 +674,6 @@ def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, 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 @@ -640,36 +688,27 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj # 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) + if len(annotation.__args__) <= 2: # 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 + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) except AttributeError: pass + # is it union? 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 - ) + for arg in _sorted_annotations(annotation.__args__) # 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: @@ -678,17 +717,10 @@ def _deserialize_with_union(deserializers, obj): 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, + module, ) except (AttributeError, IndexError): pass @@ -696,35 +728,16 @@ def _deserialize_dict( 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) + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) 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) + return functools.partial(_deserialize_sequence, deserializer, module) except (TypeError, IndexError, AttributeError, SyntaxError): pass @@ -870,5 +883,6 @@ def rest_discriminator( *, name: typing.Optional[str] = None, type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, ) -> typing.Any: - return _RestField(name=name, type=type, is_discriminator=True) + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility) diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py index 2f781d740827a..8139854b97bb8 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_serialization.py @@ -144,6 +144,8 @@ def _json_attemp(data): # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -1441,7 +1443,7 @@ def _deserialize(self, target_obj, data): elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: attributes = response._attribute_map # type: ignore diff --git a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py index bbcd28b4aa67e..be71c81bd2821 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.0b2" +VERSION = "1.0.0b1" 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 index f6ff86ec1c343..943ab8fa2ae96 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_client.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_client.py @@ -8,6 +8,7 @@ from copy import deepcopy from typing import Any, Awaitable, TYPE_CHECKING +from typing_extensions import Self from azure.core import AsyncPipelineClient from azure.core.pipeline import policies @@ -44,13 +45,14 @@ class DataMapClient: # pylint: disable=client-accepts-api-version-keyword :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. + :param endpoint: Purview Data Map Service is a fully managed cloud service whose users can + discover the data sources they need and understand the data sources they find. At the same + time, Data Map helps organizations get more value from their existing investments. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param credential: Credential used to authenticate requests to the service. 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. + :keyword api_version: The API version to use for this operation. Default value is "2023-09-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -108,7 +110,7 @@ def send_request( 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"), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) @@ -117,7 +119,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "DataMapClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self 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 index 8f67d155f7df7..74771e0faf935 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_configuration.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/aio/_configuration.py @@ -23,13 +23,14 @@ class DataMapClientConfiguration: # pylint: disable=too-many-instance-attribute Note that all parameters used to create this instance are saved as instance attributes. - :param endpoint: Required. + :param endpoint: Purview Data Map Service is a fully managed cloud service whose users can + discover the data sources they need and understand the data sources they find. At the same + time, Data Map helps organizations get more value from their existing investments. Required. :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param credential: Credential used to authenticate requests to the service. 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. + :keyword api_version: The API version to use for this operation. Default value is "2023-09-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ 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 index 3d3e3db3b6aec..88946c2d126a8 100644 --- 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 @@ -9,7 +9,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, AsyncIterator, Callable, Dict, IO, List, Optional, Type, TypeVar, Union, overload from azure.core.exceptions import ( ClientAuthenticationError, @@ -162,7 +162,6 @@ async def create_or_update( 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. @@ -196,201 +195,146 @@ async def create_or_update( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -398,170 +342,117 @@ async def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -577,7 +468,6 @@ async def create_or_update( 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. @@ -610,170 +500,117 @@ async def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -789,7 +626,6 @@ async def create_or_update( 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. @@ -822,170 +658,117 @@ async def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -1000,7 +783,6 @@ async def create_or_update( 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. @@ -1031,201 +813,146 @@ async def create_or_update( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -1233,175 +960,122 @@ async def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1432,7 +1106,7 @@ async def create_or_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1469,7 +1143,6 @@ async def get_by_ids( 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. @@ -1493,216 +1166,152 @@ async def get_by_ids( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1724,7 +1333,7 @@ async def get_by_ids( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -1762,7 +1371,6 @@ async def batch_create_or_update( 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. @@ -1798,211 +1406,147 @@ async def batch_create_or_update( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -2010,170 +1554,117 @@ async def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -2189,7 +1680,6 @@ async def batch_create_or_update( 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. @@ -2223,170 +1713,117 @@ async def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -2402,7 +1839,6 @@ async def batch_create_or_update( 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. @@ -2436,170 +1872,117 @@ async def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -2614,7 +1997,6 @@ async def batch_create_or_update( 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. @@ -2647,211 +2029,147 @@ async def batch_create_or_update( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -2859,175 +2177,122 @@ async def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3058,7 +2323,7 @@ async def batch_create_or_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3088,7 +2353,6 @@ async def batch_create_or_update( @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. @@ -3104,175 +2368,122 @@ async def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.Entit # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3291,7 +2502,7 @@ async def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.Entit params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3323,7 +2534,6 @@ async def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.Entit 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. @@ -3342,29 +2552,23 @@ async def add_classification( # pylint: disable=inconsistent-return-statements body = { "classification": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] }, "entityGuids": [ - "str" # Optional. The GUID of the entity. + "str" ] } """ @@ -3405,7 +2609,6 @@ async def add_classification( # pylint: disable=inconsistent-return-statements 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] @@ -3422,33 +2625,27 @@ async def add_classification( # pylint: disable=inconsistent-return-statements body = { "classification": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] }, "entityGuids": [ - "str" # Optional. The GUID of the entity. + "str" ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3476,7 +2673,7 @@ async def add_classification( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3488,8 +2685,6 @@ async def add_classification( # pylint: disable=inconsistent-return-statements 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) @@ -3506,7 +2701,6 @@ async def get( 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. @@ -3528,206 +2722,151 @@ async def get( response == { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3748,7 +2887,7 @@ async def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3780,7 +2919,6 @@ async def get( 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. @@ -3803,175 +2941,122 @@ async def update_attribute_by_id( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3996,7 +3081,7 @@ async def update_attribute_by_id( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4026,7 +3111,6 @@ async def update_attribute_by_id( @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. @@ -4041,175 +3125,122 @@ async def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4228,7 +3259,7 @@ async def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4260,7 +3291,6 @@ async def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult 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. @@ -4277,28 +3307,23 @@ async def get_classification( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be active or - deleted. Deleted entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time boundary. - "startTime": "str", # Optional. The start of the time - boundary. - "timeZone": "str" # Optional. The timezone of the time - boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4318,7 +3343,7 @@ async def get_classification( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4360,7 +3385,7 @@ async def remove_classification( # pylint: disable=inconsistent-return-statemen :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4380,7 +3405,7 @@ async def remove_classification( # pylint: disable=inconsistent-return-statemen params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4392,8 +3417,6 @@ async def remove_classification( # pylint: disable=inconsistent-return-statemen 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) @@ -4403,7 +3426,6 @@ async def remove_classification( # pylint: disable=inconsistent-return-statemen @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. @@ -4418,17 +3440,16 @@ async def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasCl # 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. + {} + ], + "pageSize": 0, + "sortBy": "str", + "sortType": "str", + "startIndex": 0, + "totalCount": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4447,7 +3468,7 @@ async def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasCl params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4484,7 +3505,6 @@ async def add_classifications( # pylint: disable=inconsistent-return-statements 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. @@ -4505,24 +3525,18 @@ async def add_classifications( # pylint: disable=inconsistent-return-statements body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -4562,7 +3576,7 @@ async def add_classifications( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4591,7 +3605,7 @@ async def add_classifications( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4603,8 +3617,6 @@ async def add_classifications( # pylint: disable=inconsistent-return-statements 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) @@ -4621,7 +3633,6 @@ async def update_classifications( # pylint: disable=inconsistent-return-stateme 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. @@ -4642,24 +3653,18 @@ async def update_classifications( # pylint: disable=inconsistent-return-stateme body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -4699,7 +3704,7 @@ async def update_classifications( # pylint: disable=inconsistent-return-stateme :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -4728,7 +3733,7 @@ async def update_classifications( # pylint: disable=inconsistent-return-stateme params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -4740,8 +3745,6 @@ async def update_classifications( # pylint: disable=inconsistent-return-stateme 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) @@ -4759,13 +3762,12 @@ async def get_by_unique_attribute( 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:``. + attr:\\:code:``=:code:``. NOTE: The attrName and attrValue should be unique across entities, eg. @@ -4798,206 +3800,151 @@ async def get_by_unique_attribute( response == { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -5019,7 +3966,7 @@ async def get_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -5057,7 +4004,6 @@ async def update_by_unique_attribute( 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. @@ -5097,201 +4043,146 @@ async def update_by_unique_attribute( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -5299,170 +4190,117 @@ async def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -5478,7 +4316,6 @@ async def update_by_unique_attribute( 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. @@ -5517,170 +4354,117 @@ async def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -5696,7 +4480,6 @@ async def update_by_unique_attribute( 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. @@ -5735,170 +4518,117 @@ async def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -5913,7 +4643,6 @@ async def update_by_unique_attribute( 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. @@ -5950,201 +4679,146 @@ async def update_by_unique_attribute( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -6152,175 +4826,122 @@ async def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6350,7 +4971,7 @@ async def update_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6382,12 +5003,11 @@ async def update_by_unique_attribute( 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:``. + attr:\\:code:``=\\:code:``. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. @@ -6412,175 +5032,122 @@ async def delete_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6600,7 +5167,7 @@ async def delete_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6647,7 +5214,7 @@ async def remove_classification_by_unique_attribute( # pylint: disable=inconsis :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6668,7 +5235,7 @@ async def remove_classification_by_unique_attribute( # pylint: disable=inconsis params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6680,8 +5247,6 @@ async def remove_classification_by_unique_attribute( # pylint: disable=inconsis 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) @@ -6699,7 +5264,6 @@ async def add_classifications_by_unique_attribute( # pylint: disable=inconsiste 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. @@ -6724,24 +5288,18 @@ async def add_classifications_by_unique_attribute( # pylint: disable=inconsiste body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -6800,7 +5358,7 @@ async def add_classifications_by_unique_attribute( # pylint: disable=inconsiste :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6830,7 +5388,7 @@ async def add_classifications_by_unique_attribute( # pylint: disable=inconsiste params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6842,8 +5400,6 @@ async def add_classifications_by_unique_attribute( # pylint: disable=inconsiste 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) @@ -6861,7 +5417,6 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi 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. @@ -6886,24 +5441,18 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -6962,7 +5511,7 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6992,7 +5541,7 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7004,8 +5553,6 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi 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) @@ -7017,7 +5564,6 @@ async def update_classifications_unique_by_attribute( # pylint: disable=inconsi 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. @@ -7037,87 +5583,62 @@ async def batch_set_classifications( "guidHeaderMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } } } # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -7141,7 +5662,7 @@ async def batch_set_classifications( # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -7165,7 +5686,7 @@ async def batch_set_classifications( # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -7173,7 +5694,6 @@ async def batch_set_classifications( 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. @@ -7190,90 +5710,65 @@ async def batch_set_classifications( "guidHeaderMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } } } # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -7301,7 +5796,7 @@ async def batch_set_classifications( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7339,14 +5834,13 @@ async def batch_get_by_unique_attributes( 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:`` + 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. @@ -7385,216 +5879,152 @@ async def batch_get_by_unique_attributes( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -7616,7 +6046,7 @@ async def batch_get_by_unique_attributes( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7646,7 +6076,6 @@ async def batch_get_by_unique_attributes( @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. @@ -7661,74 +6090,58 @@ async def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeade # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -7747,7 +6160,7 @@ async def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeade params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7798,7 +6211,7 @@ async def remove_business_metadata( # pylint: disable=inconsistent-return-state # JSON input template you can fill out and use as your body input. body = { "str": { - "str": {} # Optional. + "str": {} } } """ @@ -7836,7 +6249,7 @@ async def remove_business_metadata( # pylint: disable=inconsistent-return-state :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -7865,7 +6278,7 @@ async def remove_business_metadata( # pylint: disable=inconsistent-return-state params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7877,8 +6290,6 @@ async def remove_business_metadata( # pylint: disable=inconsistent-return-state 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) @@ -7918,7 +6329,7 @@ async def add_or_update_business_metadata( # pylint: disable=inconsistent-retur # JSON input template you can fill out and use as your body input. body = { "str": { - "str": {} # Optional. + "str": {} } } """ @@ -7973,7 +6384,7 @@ async def add_or_update_business_metadata( # pylint: disable=inconsistent-retur :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8003,7 +6414,7 @@ async def add_or_update_business_metadata( # pylint: disable=inconsistent-retur params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8015,8 +6426,6 @@ async def add_or_update_business_metadata( # pylint: disable=inconsistent-retur 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) @@ -8054,7 +6463,7 @@ async def remove_business_metadata_attributes( # pylint: disable=inconsistent-r # JSON input template you can fill out and use as your body input. body = { - "str": {} # Optional. + "str": {} } """ @@ -8101,7 +6510,7 @@ async def remove_business_metadata_attributes( # pylint: disable=inconsistent-r :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8131,7 +6540,7 @@ async def remove_business_metadata_attributes( # pylint: disable=inconsistent-r params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8143,8 +6552,6 @@ async def remove_business_metadata_attributes( # pylint: disable=inconsistent-r 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) @@ -8182,7 +6589,7 @@ async def add_or_update_business_metadata_attributes( # pylint: disable=inconsi # JSON input template you can fill out and use as your body input. body = { - "str": {} # Optional. + "str": {} } """ @@ -8229,7 +6636,7 @@ async def add_or_update_business_metadata_attributes( # pylint: disable=inconsi :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8259,7 +6666,7 @@ async def add_or_update_business_metadata_attributes( # pylint: disable=inconsi params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8271,8 +6678,6 @@ async def add_or_update_business_metadata_attributes( # pylint: disable=inconsi 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) @@ -8281,14 +6686,14 @@ async def add_or_update_business_metadata_attributes( # pylint: disable=inconsi return cls(pipeline_response, None, {}) # type: ignore @distributed_trace_async - async def get_business_metadata_template(self, **kwargs: Any) -> bytes: + async def get_business_metadata_template(self, **kwargs: Any) -> AsyncIterator[bytes]: """Get the sample Template for uploading/creating bulk BusinessMetaData. - :return: bytes - :rtype: bytes + :return: AsyncIterator[bytes] + :rtype: AsyncIterator[bytes] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8299,14 +6704,14 @@ async def get_business_metadata_template(self, **kwargs: Any) -> bytes: _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[bytes] = kwargs.pop("cls", None) + cls: ClsType[AsyncIterator[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), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8324,10 +6729,7 @@ async def get_business_metadata_template(self, **kwargs: Any) -> bytes: error = _deserialize(_models.AtlasErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = await response.read() + deserialized = response.iter_bytes() if cls: return cls(pipeline_response, deserialized, {}) # type: ignore @@ -8358,20 +6760,18 @@ async def import_business_metadata( response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } @@ -8394,20 +6794,18 @@ async def import_business_metadata(self, body: JSON, **kwargs: Any) -> _models.B response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } @@ -8437,25 +6835,23 @@ async def import_business_metadata( response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8480,7 +6876,7 @@ async def import_business_metadata( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8530,7 +6926,7 @@ async def remove_labels( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -8567,7 +6963,7 @@ async def remove_labels( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8599,7 +6995,7 @@ async def remove_labels( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8611,8 +7007,6 @@ async def remove_labels( # pylint: disable=inconsistent-return-statements 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) @@ -8642,7 +7036,7 @@ async def set_labels( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -8679,7 +7073,7 @@ async def set_labels( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8711,7 +7105,7 @@ async def set_labels( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8723,8 +7117,6 @@ async def set_labels( # pylint: disable=inconsistent-return-statements 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) @@ -8754,7 +7146,7 @@ async def add_label( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -8791,7 +7183,7 @@ async def add_label( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8823,7 +7215,7 @@ async def add_label( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8835,8 +7227,6 @@ async def add_label( # pylint: disable=inconsistent-return-statements 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) @@ -8888,7 +7278,7 @@ async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-ret # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -8968,7 +7358,7 @@ async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-ret :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9001,7 +7391,7 @@ async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-ret params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9013,8 +7403,6 @@ async def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-ret 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) @@ -9068,7 +7456,7 @@ async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -9152,7 +7540,7 @@ async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9185,7 +7573,7 @@ async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9197,8 +7585,6 @@ async def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return 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) @@ -9252,7 +7638,7 @@ async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -9336,7 +7722,7 @@ async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9369,7 +7755,7 @@ async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9381,8 +7767,6 @@ async def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return 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) @@ -9399,7 +7783,6 @@ async def move_entities_to_collection( content_type: str = "application/json", **kwargs: Any ) -> _models.EntityMutationResult: - # pylint: disable=line-too-long """Move existing entities to the target collection. :param body: Required. @@ -9419,178 +7802,124 @@ async def move_entities_to_collection( # 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. + "str" ] } # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -9600,7 +7929,6 @@ async def move_entities_to_collection( 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. @@ -9620,170 +7948,117 @@ async def move_entities_to_collection( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -9793,7 +8068,6 @@ async def move_entities_to_collection( 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. @@ -9813,170 +8087,117 @@ async def move_entities_to_collection( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -9986,7 +8207,6 @@ async def move_entities_to_collection( 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. @@ -10003,183 +8223,129 @@ async def move_entities_to_collection( # 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. + "str" ] } # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10209,7 +8375,7 @@ async def move_entities_to_collection( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10265,15 +8431,10 @@ async def batch_get( 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'. + 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 @@ -10296,81 +8457,59 @@ async def batch_get( { "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10393,7 +8532,7 @@ async def batch_get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10425,7 +8564,6 @@ async def batch_get( 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. @@ -10444,140 +8582,110 @@ async def create( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -10585,7 +8693,6 @@ async def create( 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. @@ -10604,70 +8711,55 @@ async def create( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -10675,7 +8767,6 @@ async def create( 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. @@ -10694,76 +8785,60 @@ async def create( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @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. @@ -10779,143 +8854,113 @@ async def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kw 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10943,7 +8988,7 @@ async def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kw params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10975,7 +9020,6 @@ async def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kw 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. @@ -10994,92 +9038,66 @@ async def create_categories( body = [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] @@ -11087,92 +9105,66 @@ async def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ @@ -11181,7 +9173,6 @@ async def create_categories( 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. @@ -11200,92 +9191,66 @@ async def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ @@ -11294,7 +9259,6 @@ async def create_categories( 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 @@ -11311,96 +9275,70 @@ async def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -11428,7 +9366,7 @@ async def create_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -11460,7 +9398,6 @@ async def create_categories( 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. @@ -11478,165 +9415,131 @@ async def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -11644,7 +9547,6 @@ async def create_category( 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. @@ -11662,83 +9564,66 @@ async def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -11746,7 +9631,6 @@ async def create_category( 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. @@ -11764,83 +9648,66 @@ async def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -11848,7 +9715,6 @@ async def create_category( 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. @@ -11863,168 +9729,134 @@ async def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12052,7 +9884,7 @@ async def create_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12082,7 +9914,6 @@ async def create_category( @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. @@ -12097,86 +9928,69 @@ async def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGl # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12195,7 +10009,7 @@ async def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGl params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12232,7 +10046,6 @@ async def update_category( 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. @@ -12252,165 +10065,131 @@ async def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -12418,7 +10197,6 @@ async def update_category( 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. @@ -12438,83 +10216,66 @@ async def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -12522,7 +10283,6 @@ async def update_category( 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. @@ -12542,83 +10302,66 @@ async def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -12626,7 +10369,6 @@ async def update_category( 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. @@ -12643,168 +10385,134 @@ async def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12833,7 +10541,7 @@ async def update_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12873,7 +10581,7 @@ async def delete_category( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12892,7 +10600,7 @@ async def delete_category( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12904,8 +10612,6 @@ async def delete_category( # pylint: disable=inconsistent-return-statements 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) @@ -12917,7 +10623,6 @@ async def delete_category( # pylint: disable=inconsistent-return-statements 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. @@ -12938,89 +10643,72 @@ async def partial_update_category( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -13028,7 +10716,6 @@ async def partial_update_category( 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. @@ -13050,83 +10737,66 @@ async def partial_update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -13134,7 +10804,6 @@ async def partial_update_category( 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. @@ -13153,86 +10822,69 @@ async def partial_update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -13261,7 +10913,7 @@ async def partial_update_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -13321,19 +10973,16 @@ async def get_related_categories( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -13355,7 +11004,7 @@ async def get_related_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -13393,7 +11042,6 @@ async def get_category_terms( 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. @@ -13414,19 +11062,17 @@ async def get_category_terms( # 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -13448,7 +11094,7 @@ async def get_category_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -13485,7 +11131,6 @@ async def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -13504,666 +11149,512 @@ async def create_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -14178,7 +11669,6 @@ async def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -14197,333 +11687,256 @@ async def create_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -14538,7 +11951,6 @@ async def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -14557,333 +11969,256 @@ async def create_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -14897,7 +12232,6 @@ async def create_term( 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. @@ -14913,671 +12247,517 @@ async def create_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15606,7 +12786,7 @@ async def create_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15636,7 +12816,6 @@ async def create_term( @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. @@ -15650,338 +12829,261 @@ async def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTe # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", + "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -16001,7 +13103,7 @@ async def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTe params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -16039,7 +13141,6 @@ async def update_term( 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. @@ -16060,666 +13161,512 @@ async def update_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -16735,7 +13682,6 @@ async def update_term( 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. @@ -16756,333 +13702,256 @@ async def update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -17098,7 +13967,6 @@ async def update_term( 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. @@ -17119,333 +13987,256 @@ async def update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -17460,7 +14251,6 @@ async def update_term( 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. @@ -17478,671 +14268,517 @@ async def update_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -18173,7 +14809,7 @@ async def update_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -18211,7 +14847,7 @@ async def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: dis :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -18230,7 +14866,7 @@ async def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: dis params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -18242,8 +14878,6 @@ async def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: dis 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) @@ -18261,7 +14895,6 @@ async def partial_update_term( 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. @@ -18284,338 +14917,261 @@ async def partial_update_term( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -18631,7 +15187,6 @@ async def partial_update_term( 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. @@ -18654,333 +15209,256 @@ async def partial_update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -18995,7 +15473,6 @@ async def partial_update_term( 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. @@ -19015,338 +15492,261 @@ async def partial_update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -19377,7 +15777,7 @@ async def partial_update_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -19414,7 +15814,6 @@ async def create_terms( 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. @@ -19434,369 +15833,256 @@ async def create_terms( # JSON input template you can fill out and use as your body input. body = [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -19805,369 +16091,256 @@ async def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -20183,7 +16356,6 @@ async def create_terms( 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. @@ -20203,369 +16375,256 @@ async def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -20580,7 +16639,6 @@ async def create_terms( 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 @@ -20598,375 +16656,262 @@ async def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -20996,7 +16941,7 @@ async def create_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21034,7 +16979,6 @@ async def get_entities_assigned_with_term( 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. @@ -21056,31 +17000,27 @@ async def get_entities_assigned_with_term( # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21102,7 +17042,7 @@ async def get_entities_assigned_with_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21139,7 +17079,6 @@ async def assign_term_to_entities( # pylint: disable=inconsistent-return-statem 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. @@ -21165,26 +17104,22 @@ async def assign_term_to_entities( # pylint: disable=inconsistent-return-statem # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] @@ -21235,7 +17170,7 @@ async def assign_term_to_entities( # pylint: disable=inconsistent-return-statem :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21264,7 +17199,7 @@ async def assign_term_to_entities( # pylint: disable=inconsistent-return-statem params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21276,8 +17211,6 @@ async def assign_term_to_entities( # pylint: disable=inconsistent-return-statem 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) @@ -21294,7 +17227,6 @@ async def delete_term_assignment_from_entities( # pylint: disable=inconsistent- 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. @@ -21315,26 +17247,22 @@ async def delete_term_assignment_from_entities( # pylint: disable=inconsistent- # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] @@ -21374,7 +17302,7 @@ async def delete_term_assignment_from_entities( # pylint: disable=inconsistent- :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21403,7 +17331,7 @@ async def delete_term_assignment_from_entities( # pylint: disable=inconsistent- params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21415,8 +17343,6 @@ async def delete_term_assignment_from_entities( # pylint: disable=inconsistent- 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) @@ -21434,7 +17360,6 @@ async def get_related_terms( 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. @@ -21457,22 +17382,18 @@ async def get_related_terms( 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21495,7 +17416,7 @@ async def get_related_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21525,7 +17446,6 @@ async def get_related_terms( @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. @@ -21541,73 +17461,58 @@ async def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21626,7 +17531,7 @@ async def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21664,7 +17569,6 @@ async def update( 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. @@ -21688,140 +17592,110 @@ async def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -21835,7 +17709,6 @@ async def update( 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. @@ -21859,70 +17732,55 @@ async def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -21936,7 +17794,6 @@ async def update( 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. @@ -21960,70 +17817,55 @@ async def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -22036,7 +17878,6 @@ async def update( 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. @@ -22057,143 +17898,113 @@ async def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -22224,7 +18035,7 @@ async def update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -22263,7 +18074,7 @@ async def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disa :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -22282,7 +18093,7 @@ async def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disa params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -22294,8 +18105,6 @@ async def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disa 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) @@ -22313,7 +18122,6 @@ async def get_categories( 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. @@ -22336,96 +18144,70 @@ async def get_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -22447,7 +18229,7 @@ async def get_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -22506,17 +18288,15 @@ async def get_categories_headers( # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -22538,7 +18318,7 @@ async def get_categories_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -22568,7 +18348,6 @@ async def get_categories_headers( @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. @@ -22591,587 +18370,379 @@ async def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGl 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" + }, + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "termInfo": { "str": { - "abbreviation": "str", # Optional. The abbreviation of the - term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the - glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. - "typeName": "str" # Optional. The - name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique - attributes of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes - of the term, which is map>. The key of - the first layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display - text. - "guid": "str", # Optional. The GUID of the - object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource - Id. - "typeName": "str", # Optional. The name of - the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique - attributes of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display - name for url. - "url": "str" # Optional. web url. http or - https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23191,7 +18762,7 @@ async def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGl params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23229,7 +18800,6 @@ async def partial_update( 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. @@ -23259,77 +18829,62 @@ async def partial_update( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -23343,7 +18898,6 @@ async def partial_update( 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. @@ -23375,70 +18929,55 @@ async def partial_update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -23451,7 +18990,6 @@ async def partial_update( 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. @@ -23480,73 +19018,58 @@ async def partial_update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23577,7 +19100,7 @@ async def partial_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23615,7 +19138,6 @@ async def get_terms( 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. @@ -23637,375 +19159,262 @@ async def get_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24028,7 +19437,7 @@ async def get_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24066,7 +19475,6 @@ async def get_term_headers( 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. @@ -24088,19 +19496,17 @@ async def get_term_headers( # 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24122,7 +19528,7 @@ async def get_term_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24172,10 +19578,9 @@ def __init__(self, *args, **kwargs) -> None: 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. + :param body: Body parameter. 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". @@ -24189,43 +19594,33 @@ async def query( # 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. + "continuationToken": "str", "facets": [ { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } ], - "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. + "filter": {}, + "keywords": "str", + "limit": 0, "orderby": [ - {} # Optional. The sort order of search results, can specify - multiple fields. + {} ], "taxonomySetting": { "assetTypes": [ - "str" # Optional. Asset types. + "str" ], "facet": { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } } @@ -24233,164 +19628,131 @@ async def query( # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -24398,10 +19760,9 @@ async def query( @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. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -24415,164 +19776,131 @@ async def query(self, body: JSON, *, content_type: str = "application/json", **k # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -24582,10 +19910,9 @@ async def query(self, body: JSON, *, content_type: str = "application/json", **k 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. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -24599,164 +19926,131 @@ async def query( # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -24764,10 +20058,10 @@ async def query( @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. + :param body: Body parameter. 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 @@ -24778,43 +20072,33 @@ async def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwar # 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. + "continuationToken": "str", "facets": [ { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } ], - "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. + "filter": {}, + "keywords": "str", + "limit": 0, "orderby": [ - {} # Optional. The sort order of search results, can specify - multiple fields. + {} ], "taxonomySetting": { "assetTypes": [ - "str" # Optional. Asset types. + "str" ], "facet": { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } } @@ -24822,169 +20106,136 @@ async def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwar # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25013,7 +20264,7 @@ async def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwar params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25045,10 +20296,9 @@ async def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwar 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. + :param body: Body parameter. 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". @@ -25062,83 +20312,57 @@ async def suggest( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -25148,10 +20372,9 @@ async def suggest( 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. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -25167,70 +20390,48 @@ async def suggest( 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -25240,10 +20441,9 @@ async def suggest( 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. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -25259,70 +20459,48 @@ async def suggest( 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -25332,10 +20510,10 @@ async def suggest( 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. + :param body: Body parameter. 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 @@ -25346,88 +20524,62 @@ async def suggest( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25456,7 +20608,7 @@ async def suggest( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25488,10 +20640,9 @@ async def suggest( 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. + :param body: Body parameter. 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". @@ -25505,21 +20656,17 @@ async def auto_complete( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "queryPlusText": "str", + "text": "str" } ] } @@ -25531,7 +20678,7 @@ async def auto_complete( ) -> _models.AutoCompleteResult: """Get auto complete options. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -25547,9 +20694,8 @@ async def auto_complete( response == { "value": [ { - "queryPlusText": "str", # Optional. The completed search - query text. - "text": "str" # Optional. The completed term or phrase. + "queryPlusText": "str", + "text": "str" } ] } @@ -25561,7 +20707,7 @@ async def auto_complete( ) -> _models.AutoCompleteResult: """Get auto complete options. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -25577,9 +20723,8 @@ async def auto_complete( response == { "value": [ { - "queryPlusText": "str", # Optional. The completed search - query text. - "text": "str" # Optional. The completed term or phrase. + "queryPlusText": "str", + "text": "str" } ] } @@ -25589,10 +20734,10 @@ async def auto_complete( 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. + :param body: Body parameter. 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 @@ -25603,26 +20748,22 @@ async def auto_complete( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "queryPlusText": "str", + "text": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25651,7 +20792,7 @@ async def auto_complete( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25701,7 +20842,6 @@ def __init__(self, *args, **kwargs) -> None: 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. @@ -25720,118 +20860,87 @@ async def get( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25852,7 +20961,7 @@ async def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25890,7 +20999,6 @@ async def get_next_page( 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. @@ -25911,118 +21019,87 @@ async def get_next_page( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26045,7 +21122,7 @@ async def get_next_page( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26083,7 +21160,6 @@ async def get_by_unique_attribute( 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, @@ -26121,118 +21197,87 @@ async def get_by_unique_attribute( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26254,7 +21299,7 @@ async def get_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26321,71 +21366,67 @@ async def create( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26410,36 +21451,34 @@ async def create( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26464,36 +21503,34 @@ async def create( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26515,74 +21552,70 @@ async def create( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26610,7 +21643,7 @@ async def create( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26659,71 +21692,67 @@ async def update( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26748,36 +21777,34 @@ async def update( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26802,36 +21829,34 @@ async def update( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -26853,74 +21878,70 @@ async def update( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26948,7 +21969,7 @@ async def update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26980,7 +22001,6 @@ async def update( 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. @@ -27000,120 +22020,91 @@ async def get( "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, "relationship": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27133,7 +22124,7 @@ async def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27171,7 +22162,7 @@ async def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inc :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27190,7 +22181,7 @@ async def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inc params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27202,8 +22193,6 @@ async def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inc 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) @@ -27231,7 +22220,6 @@ def __init__(self, *args, **kwargs) -> None: @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. @@ -27248,111 +22236,87 @@ async def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27371,7 +22335,7 @@ async def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27401,7 +22365,6 @@ async def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models @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. @@ -27418,111 +22381,87 @@ async def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _mode response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27541,7 +22480,7 @@ async def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _mode params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27571,7 +22510,6 @@ async def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _mode @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. @@ -27587,130 +22525,96 @@ async def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.At response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27729,7 +22633,7 @@ async def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.At params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27759,7 +22663,6 @@ async def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.At @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. @@ -27775,130 +22678,96 @@ async def get_classification_by_name(self, name: str, **kwargs: Any) -> _models. response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27917,7 +22786,7 @@ async def get_classification_by_name(self, name: str, **kwargs: Any) -> _models. params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27947,7 +22816,6 @@ async def get_classification_by_name(self, name: str, **kwargs: Any) -> _models. @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. @@ -27963,158 +22831,121 @@ async def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntit response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28133,7 +22964,7 @@ async def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntit params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28163,7 +22994,6 @@ async def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntit @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. @@ -28179,158 +23009,121 @@ async def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnt response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28349,7 +23142,7 @@ async def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnt params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28379,7 +23172,6 @@ async def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnt @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. @@ -28393,87 +23185,71 @@ async def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef # 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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28492,7 +23268,7 @@ async def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28522,7 +23298,6 @@ async def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef @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. @@ -28536,87 +23311,71 @@ async def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumD # 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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28635,7 +23394,7 @@ async def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumD params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28665,7 +23424,6 @@ async def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumD @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. @@ -28681,144 +23439,105 @@ async def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.Atla response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28837,7 +23556,7 @@ async def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.Atla params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28867,7 +23586,6 @@ async def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.Atla @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. @@ -28883,144 +23601,105 @@ async def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.At response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29039,7 +23718,7 @@ async def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.At params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29069,7 +23748,6 @@ async def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.At @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. @@ -29085,111 +23763,87 @@ async def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStruc response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29208,7 +23862,7 @@ async def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStruc params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29238,7 +23892,6 @@ async def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStruc @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. @@ -29254,111 +23907,87 @@ async def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStr response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29377,7 +24006,7 @@ async def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStr params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29407,7 +24036,6 @@ async def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStr @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. @@ -29423,215 +24051,150 @@ async def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "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. + "str": "str" + }, + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29650,7 +24213,7 @@ async def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29680,7 +24243,6 @@ async def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: @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. @@ -29696,215 +24258,150 @@ async def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "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. + "str": "str" + }, + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29923,7 +24420,7 @@ async def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29961,7 +24458,7 @@ async def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29980,7 +24477,7 @@ async def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29992,8 +24489,6 @@ async def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc 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) @@ -30009,7 +24504,6 @@ async def get( 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. @@ -30033,948 +24527,636 @@ async def get( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30995,7 +25177,7 @@ async def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31027,10 +25209,7 @@ async def get( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: ~azure.purview.datamap.models.AtlasTypesDef @@ -31050,943 +25229,631 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -31997,943 +25864,631 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -32943,10 +26498,7 @@ async def batch_create( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: JSON @@ -32966,943 +26518,631 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -33912,10 +27152,7 @@ async def batch_create( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: IO[bytes] @@ -33935,943 +27172,631 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -34881,10 +27806,7 @@ async def batch_create( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :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] @@ -34901,943 +27823,631 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -35848,948 +28458,636 @@ async def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -36817,7 +29115,7 @@ async def batch_create( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -36849,7 +29147,6 @@ async def batch_create( 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. @@ -36871,943 +29168,631 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -37818,943 +29803,631 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -38764,7 +30437,6 @@ async def batch_update( 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. @@ -38786,943 +30458,631 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -39732,7 +31092,6 @@ async def batch_update( 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. @@ -39754,943 +31113,631 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -40700,7 +31747,6 @@ async def batch_update( 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. @@ -40719,943 +31765,631 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -41666,948 +32400,636 @@ async def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -42635,7 +33057,7 @@ async def batch_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -42667,7 +33089,6 @@ async def batch_update( 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. @@ -42688,943 +33109,631 @@ async def batch_delete( # pylint: disable=inconsistent-return-statements { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -43666,7 +33775,6 @@ async def batch_delete( # pylint: disable=inconsistent-return-statements 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. @@ -43684,948 +33792,636 @@ async def batch_delete( # pylint: disable=inconsistent-return-statements { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -44653,7 +34449,7 @@ async def batch_delete( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -44665,8 +34461,6 @@ async def batch_delete( # pylint: disable=inconsistent-return-statements 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) @@ -44682,7 +34476,6 @@ async def get_headers( 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. @@ -44703,16 +34496,13 @@ async def get_headers( # 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. + "category": "str", + "guid": "str", + "name": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -44733,7 +34523,7 @@ async def get_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -44763,7 +34553,6 @@ async def get_headers( @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. @@ -44779,111 +34568,87 @@ async def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.Ter response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -44903,7 +34668,7 @@ async def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.Ter params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -44933,7 +34698,6 @@ async def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.Ter @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. @@ -44949,111 +34713,87 @@ async def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.T response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -45073,7 +34813,7 @@ async def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.T params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) 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 index 2f689398273bf..5dc5f76121275 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_models.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/models/_models.py @@ -95,8 +95,7 @@ def __init__( 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]): @@ -198,8 +197,7 @@ def __init__( 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]): @@ -261,8 +259,7 @@ def __init__( 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]): @@ -420,8 +417,7 @@ def __init__( 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]): @@ -476,8 +472,7 @@ def __init__( 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]): @@ -510,8 +505,7 @@ def __init__( *, params: Optional[Dict[str, Any]] = None, type: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -545,8 +539,7 @@ def __init__( *, referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = None, entities: Optional[List["_models.AtlasEntity"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -683,8 +676,7 @@ def __init__( 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]): @@ -804,8 +796,7 @@ def __init__( 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]): @@ -890,8 +881,7 @@ def __init__( 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]): @@ -919,8 +909,7 @@ def __init__( self, *, guid_header_map: Optional[Dict[str, "_models.AtlasEntityHeader"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -954,8 +943,7 @@ def __init__( *, referred_entities: Optional[Dict[str, "_models.AtlasEntity"]] = None, entity: Optional["_models.AtlasEntity"] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1062,8 +1050,7 @@ def __init__( 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]): @@ -1101,8 +1088,7 @@ def __init__( description: Optional[str] = None, ordinal: Optional[int] = None, value: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1140,8 +1126,7 @@ def __init__( request_id: Optional[str] = None, error_code: Optional[str] = None, error_message: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1239,8 +1224,7 @@ def __init__( language: Optional[str] = None, terms: Optional[List["_models.AtlasRelatedTermHeader"]] = None, usage: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1338,8 +1322,7 @@ def __init__( 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]): @@ -1447,8 +1430,7 @@ def __init__( 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]): @@ -1486,8 +1468,7 @@ def __init__( display_text: Optional[str] = None, glossary_guid: Optional[str] = None, relation_guid: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1701,8 +1682,7 @@ def __init__( 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]): @@ -1771,8 +1751,7 @@ def __init__( 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]): @@ -1810,8 +1789,7 @@ def __init__( guid: Optional[str] = None, type_name: Optional[str] = None, unique_attributes: Optional[Dict[str, Any]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1859,8 +1837,7 @@ def __init__( display_text: Optional[str] = None, parent_category_guid: Optional[str] = None, relation_guid: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -1935,8 +1912,7 @@ def __init__( 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]): @@ -1996,8 +1972,7 @@ def __init__( status: Optional[Union[str, "_models.AtlasTermRelationshipStatus"]] = None, steward: Optional[str] = None, term_guid: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -2096,8 +2071,7 @@ def __init__( update_time: Optional[int] = None, updated_by: Optional[str] = None, version: Optional[int] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -2200,8 +2174,7 @@ def __init__( 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]): @@ -2391,8 +2364,7 @@ def __init__( 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]): @@ -2450,8 +2422,7 @@ def __init__( is_legacy_attribute: Optional[bool] = None, name: Optional[str] = None, type: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -2484,8 +2455,7 @@ def __init__( *, referred_entities: Optional[Dict[str, "_models.AtlasEntityHeader"]] = None, relationship: Optional["_models.AtlasRelationship"] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -2524,8 +2494,7 @@ def __init__( 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]): @@ -2627,8 +2596,7 @@ def __init__( 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]): @@ -2698,8 +2666,7 @@ def __init__( status: Optional[Union[str, "_models.AtlasTermAssignmentStatus"]] = None, steward: Optional[str] = None, term_guid: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -2749,8 +2716,7 @@ def __init__( 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]): @@ -2981,8 +2947,7 @@ def __init__( 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]): @@ -3024,8 +2989,7 @@ def __init__( category: Optional[Union[str, "_models.TypeCategory"]] = None, guid: Optional[str] = None, name: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3083,8 +3047,7 @@ def __init__( 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]): @@ -3126,8 +3089,7 @@ def __init__( keywords: Optional[str] = None, limit: Optional[int] = None, filter: Optional[Any] = None, # pylint: disable=redefined-builtin - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3155,8 +3117,7 @@ def __init__( self, *, value: Optional[List["_models.AutoCompleteResultValue"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3189,8 +3150,7 @@ def __init__( *, text: Optional[str] = None, query_plus_text: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3223,8 +3183,7 @@ def __init__( *, 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]): @@ -3254,8 +3213,7 @@ def __init__( self, *, file: FileType, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3290,8 +3248,7 @@ def __init__( *, classification: Optional["_models.AtlasClassification"] = None, entity_guids: Optional[List[str]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3324,8 +3281,7 @@ def __init__( *, id: Optional[str] = None, # pylint: disable=redefined-builtin info: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3365,8 +3321,7 @@ def __init__( 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]): @@ -3434,8 +3389,7 @@ def __init__( 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]): @@ -3473,8 +3427,7 @@ def __init__( 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]): @@ -3517,8 +3470,7 @@ def __init__( 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]): @@ -3556,8 +3508,7 @@ def __init__( 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]): @@ -3585,8 +3536,7 @@ def __init__( self, *, entity_guids: Optional[List[str]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3681,8 +3631,7 @@ def __init__( 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]): @@ -3720,8 +3669,7 @@ def __init__( 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]): @@ -3784,8 +3732,7 @@ def __init__( item_path: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3848,8 +3795,7 @@ def __init__( 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]): @@ -3905,8 +3851,7 @@ def __init__( 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]): @@ -3939,8 +3884,7 @@ def __init__( *, display_name: Optional[str] = None, url: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -3978,8 +3922,7 @@ def __init__( count: Optional[int] = None, facet: Optional[str] = None, sort: Optional["_models.SearchFacetSort"] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4012,8 +3955,7 @@ def __init__( *, count: Optional[int] = None, value: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4088,8 +4030,7 @@ def __init__( 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]): @@ -4122,8 +4063,7 @@ def __init__( *, count: Optional[Union[str, "_models.SearchSortOrder"]] = None, value: Optional[Union[str, "_models.SearchSortOrder"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4174,8 +4114,7 @@ def __init__( name: Optional[List[str]] = None, description: Optional[List[str]] = None, entity_type: Optional[List[str]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4322,8 +4261,7 @@ def __init__( term_status: Optional[str] = None, term_template: Optional[List[str]] = None, long_description: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4356,8 +4294,7 @@ def __init__( *, asset_types: Optional[List[str]] = None, facet: Optional["_models.SearchFacetItem"] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4403,8 +4340,7 @@ def __init__( keywords: Optional[str] = None, limit: Optional[int] = None, filter: Optional[Any] = None, # pylint: disable=redefined-builtin - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4432,8 +4368,7 @@ def __init__( self, *, value: Optional[List["_models.SuggestResultValue"]] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4575,8 +4510,7 @@ def __init__( term_status: Optional[str] = None, term_template: Optional[List[str]] = None, long_description: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4614,8 +4548,7 @@ def __init__( name: Optional[str] = None, glossary_name: Optional[str] = None, guid: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4717,8 +4650,7 @@ def __init__( 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]): @@ -4756,8 +4688,7 @@ def __init__( end_time: Optional[str] = None, start_time: Optional[str] = None, time_zone: Optional[str] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): @@ -4810,8 +4741,7 @@ def __init__( default: Optional["_models.TimeZone"] = None, display_name: Optional[str] = None, raw_offset: Optional[int] = None, - ): - ... + ): ... @overload def __init__(self, mapping: Mapping[str, Any]): 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 index 2dbd9c71546af..40830b96fa652 100644 --- a/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_operations.py +++ b/sdk/purview/azure-purview-datamap/azure/purview/datamap/operations/_operations.py @@ -9,7 +9,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, Iterator, List, Optional, Type, TypeVar, Union, overload from azure.core.exceptions import ( ClientAuthenticationError, @@ -68,9 +68,9 @@ def build_entity_create_or_update_request( _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -129,9 +129,9 @@ def build_entity_batch_create_or_update_request( # pylint: disable=name-too-lon ) # 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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -158,12 +158,15 @@ 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)) + accept = _headers.pop("Accept", "application/json") + # 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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -202,7 +205,7 @@ def build_entity_update_attribute_by_id_request( # pylint: disable=name-too-lon _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)) + content_type: str = kwargs.pop("content_type") accept = _headers.pop("Accept", "application/json") # Construct URL @@ -217,9 +220,8 @@ def build_entity_update_attribute_by_id_request( # pylint: disable=name-too-lon _params["name"] = _SERIALIZER.query("name", name, "str") # Construct headers + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "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="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -266,6 +268,10 @@ def build_entity_get_classification_request(guid: str, classification_name: str, def build_entity_remove_classification_request( # pylint: disable=name-too-long 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 = { @@ -275,7 +281,10 @@ def build_entity_remove_classification_request( # pylint: disable=name-too-long _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_entity_get_classifications_request(guid: str, **kwargs: Any) -> HttpRequest: @@ -301,6 +310,8 @@ def build_entity_add_classifications_request(guid: str, **kwargs: Any) -> HttpRe _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/guid/{guid}/classifications" path_format_arguments = { @@ -312,6 +323,7 @@ def build_entity_add_classifications_request(guid: str, **kwargs: Any) -> HttpRe # 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) @@ -322,6 +334,8 @@ def build_entity_update_classifications_request( # pylint: disable=name-too-lon _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/guid/{guid}/classifications" path_format_arguments = { @@ -333,6 +347,7 @@ def build_entity_update_classifications_request( # pylint: disable=name-too-lon # 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="PUT", url=_url, headers=_headers, **kwargs) @@ -394,9 +409,9 @@ def build_entity_update_by_unique_attribute_request( # pylint: disable=name-too _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -430,8 +445,11 @@ def build_entity_delete_by_unique_attribute_request( # pylint: disable=name-too 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: + _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}/classification/{classificationName}" path_format_arguments = { @@ -445,7 +463,10 @@ def build_entity_remove_classification_by_unique_attribute_request( # pylint: d if attribute is not None: _params["attr:qualifiedName"] = _SERIALIZER.query("attribute", attribute, "str") - return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) def build_entity_add_classifications_by_unique_attribute_request( # pylint: disable=name-too-long @@ -455,6 +476,8 @@ def build_entity_add_classifications_by_unique_attribute_request( # pylint: dis _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}/classifications" path_format_arguments = { @@ -470,6 +493,7 @@ def build_entity_add_classifications_by_unique_attribute_request( # pylint: dis # 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, params=_params, headers=_headers, **kwargs) @@ -481,6 +505,8 @@ def build_entity_update_classifications_unique_by_attribute_request( # pylint: _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}/classifications" path_format_arguments = { @@ -496,6 +522,7 @@ def build_entity_update_classifications_unique_by_attribute_request( # pylint: # 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="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -510,9 +537,9 @@ def build_entity_batch_set_classifications_request(**kwargs: Any) -> HttpRequest _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -577,6 +604,8 @@ def build_entity_remove_business_metadata_request( # pylint: disable=name-too-l _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/guid/{guid}/businessmetadata" path_format_arguments = { @@ -588,6 +617,7 @@ def build_entity_remove_business_metadata_request( # pylint: disable=name-too-l # 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="DELETE", url=_url, headers=_headers, **kwargs) @@ -599,6 +629,8 @@ def build_entity_add_or_update_business_metadata_request( # pylint: disable=nam _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}/businessmetadata" path_format_arguments = { @@ -614,6 +646,7 @@ def build_entity_add_or_update_business_metadata_request( # pylint: disable=nam # 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, params=_params, headers=_headers, **kwargs) @@ -624,6 +657,8 @@ def build_entity_remove_business_metadata_attributes_request( # pylint: disable _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/guid/{guid}/businessmetadata/{businessMetadataName}" path_format_arguments = { @@ -636,6 +671,7 @@ def build_entity_remove_business_metadata_attributes_request( # pylint: disable # 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="DELETE", url=_url, headers=_headers, **kwargs) @@ -646,6 +682,8 @@ def build_entity_add_or_update_business_metadata_attributes_request( # pylint: _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/guid/{guid}/businessmetadata/{businessMetadataName}" path_format_arguments = { @@ -658,6 +696,7 @@ def build_entity_add_or_update_business_metadata_attributes_request( # pylint: # 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) @@ -694,6 +733,8 @@ 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)) + accept = _headers.pop("Accept", "application/json") + # Construct URL _url = "/atlas/v2/entity/guid/{guid}/labels" path_format_arguments = { @@ -705,6 +746,7 @@ def build_entity_remove_labels_request(guid: str, **kwargs: Any) -> HttpRequest: # 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="DELETE", url=_url, headers=_headers, **kwargs) @@ -713,6 +755,8 @@ 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)) + accept = _headers.pop("Accept", "application/json") + # Construct URL _url = "/atlas/v2/entity/guid/{guid}/labels" path_format_arguments = { @@ -724,6 +768,7 @@ def build_entity_set_labels_request(guid: str, **kwargs: Any) -> HttpRequest: # 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) @@ -732,6 +777,8 @@ 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)) + accept = _headers.pop("Accept", "application/json") + # Construct URL _url = "/atlas/v2/entity/guid/{guid}/labels" path_format_arguments = { @@ -743,6 +790,7 @@ def build_entity_add_label_request(guid: str, **kwargs: Any) -> HttpRequest: # 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="PUT", url=_url, headers=_headers, **kwargs) @@ -754,6 +802,8 @@ def build_entity_remove_labels_by_unique_attribute_request( # pylint: disable=n _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}/labels" path_format_arguments = { @@ -769,6 +819,7 @@ def build_entity_remove_labels_by_unique_attribute_request( # pylint: disable=n # 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="DELETE", url=_url, params=_params, headers=_headers, **kwargs) @@ -780,6 +831,8 @@ def build_entity_set_labels_by_unique_attribute_request( # pylint: disable=name _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}/labels" path_format_arguments = { @@ -795,6 +848,7 @@ def build_entity_set_labels_by_unique_attribute_request( # pylint: disable=name # 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, params=_params, headers=_headers, **kwargs) @@ -806,6 +860,8 @@ def build_entity_add_labels_by_unique_attribute_request( # pylint: disable=name _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}/labels" path_format_arguments = { @@ -821,6 +877,7 @@ def build_entity_add_labels_by_unique_attribute_request( # pylint: disable=name # 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="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -843,9 +900,9 @@ def build_entity_move_entities_to_collection_request( # pylint: disable=name-to _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -897,9 +954,9 @@ def build_glossary_create_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -914,9 +971,9 @@ def build_glossary_create_categories_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -931,9 +988,9 @@ def build_glossary_create_category_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -972,14 +1029,18 @@ def build_glossary_update_category_request(category_id: str, **kwargs: Any) -> H _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) def build_glossary_delete_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 = { @@ -988,7 +1049,10 @@ def build_glossary_delete_category_request(category_id: str, **kwargs: Any) -> H _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_glossary_partial_update_category_request( # pylint: disable=name-too-long @@ -1008,9 +1072,9 @@ def build_glossary_partial_update_category_request( # pylint: disable=name-too- _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) @@ -1100,9 +1164,9 @@ def build_glossary_create_term_request(*, include_term_hierarchy: Optional[bool] _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -1157,14 +1221,18 @@ def build_glossary_update_term_request( _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) def build_glossary_delete_term_request(term_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/term/{termId}" path_format_arguments = { @@ -1173,7 +1241,10 @@ def build_glossary_delete_term_request(term_id: str, **kwargs: Any) -> HttpReque _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_glossary_partial_update_term_request( # pylint: disable=name-too-long @@ -1201,9 +1272,9 @@ def build_glossary_partial_update_term_request( # pylint: disable=name-too-long _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -1226,9 +1297,9 @@ def build_glossary_create_terms_request(*, include_term_hierarchy: Optional[bool _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -1274,6 +1345,8 @@ def build_glossary_assign_term_to_entities_request( # pylint: disable=name-too- _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/terms/{termId}/assignedEntities" path_format_arguments = { @@ -1285,6 +1358,7 @@ def build_glossary_assign_term_to_entities_request( # pylint: disable=name-too- # 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) @@ -1295,6 +1369,8 @@ def build_glossary_delete_term_assignment_from_entities_request( # pylint: disa _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/terms/{termId}/assignedEntities" path_format_arguments = { @@ -1306,6 +1382,7 @@ def build_glossary_delete_term_assignment_from_entities_request( # pylint: disa # 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="DELETE", url=_url, headers=_headers, **kwargs) @@ -1394,14 +1471,18 @@ def build_glossary_update_request( ) # 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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) def build_glossary_delete_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 = { @@ -1410,7 +1491,10 @@ def build_glossary_delete_request(glossary_id: str, **kwargs: Any) -> HttpReques _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_glossary_get_categories_request( @@ -1535,9 +1619,9 @@ def build_glossary_partial_update_request( ) # 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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) @@ -1630,9 +1714,9 @@ def build_discovery_query_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -1652,9 +1736,9 @@ def build_discovery_suggest_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -1674,9 +1758,9 @@ def build_discovery_auto_complete_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) @@ -1788,9 +1872,9 @@ def build_relationship_create_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -1805,9 +1889,9 @@ def build_relationship_update_request(**kwargs: Any) -> HttpRequest: _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) @@ -1837,6 +1921,10 @@ def build_relationship_get_request(guid: str, *, extended_info: Optional[bool] = def build_relationship_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/relationship/guid/{guid}" path_format_arguments = { @@ -1845,7 +1933,10 @@ def build_relationship_delete_request(guid: str, **kwargs: Any) -> HttpRequest: _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_type_definition_get_business_metadata_by_id_request( # pylint: disable=name-too-long @@ -2139,6 +2230,10 @@ def build_type_definition_get_by_name_request(name: str, **kwargs: Any) -> HttpR def build_type_definition_delete_request(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/typedef/name/{name}" path_format_arguments = { @@ -2147,7 +2242,10 @@ def build_type_definition_delete_request(name: str, **kwargs: Any) -> HttpReques _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) def build_type_definition_get_request( @@ -2189,9 +2287,9 @@ def build_type_definition_batch_create_request(**kwargs: Any) -> HttpRequest: # _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) @@ -2206,9 +2304,9 @@ def build_type_definition_batch_update_request(**kwargs: Any) -> HttpRequest: # _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") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") return HttpRequest(method="PUT", url=_url, headers=_headers, **kwargs) @@ -2217,12 +2315,15 @@ def build_type_definition_batch_delete_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/types/typedefs" # 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="DELETE", url=_url, headers=_headers, **kwargs) @@ -2335,7 +2436,6 @@ def create_or_update( 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. @@ -2369,201 +2469,146 @@ def create_or_update( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -2571,170 +2616,117 @@ def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -2750,7 +2742,6 @@ def create_or_update( 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. @@ -2783,170 +2774,117 @@ def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -2962,7 +2900,6 @@ def create_or_update( 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. @@ -2995,170 +2932,117 @@ def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -3173,7 +3057,6 @@ def create_or_update( 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. @@ -3204,201 +3087,146 @@ def create_or_update( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -3406,175 +3234,122 @@ def create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3605,7 +3380,7 @@ def create_or_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3642,7 +3417,6 @@ def get_by_ids( 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. @@ -3666,216 +3440,152 @@ def get_by_ids( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -3897,7 +3607,7 @@ def get_by_ids( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -3935,7 +3645,6 @@ def batch_create_or_update( 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. @@ -3971,211 +3680,147 @@ def batch_create_or_update( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -4183,170 +3828,117 @@ def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -4362,7 +3954,6 @@ def batch_create_or_update( 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. @@ -4396,170 +3987,117 @@ def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -4575,7 +4113,6 @@ def batch_create_or_update( 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. @@ -4609,170 +4146,117 @@ def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -4787,7 +4271,6 @@ def batch_create_or_update( 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. @@ -4820,211 +4303,147 @@ def batch_create_or_update( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -5032,175 +4451,122 @@ def batch_create_or_update( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -5231,7 +4597,7 @@ def batch_create_or_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -5261,7 +4627,6 @@ def batch_create_or_update( @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. @@ -5277,175 +4642,122 @@ def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.EntityMutat # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -5464,7 +4776,7 @@ def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.EntityMutat params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -5496,7 +4808,6 @@ def batch_delete(self, *, guid: List[str], **kwargs: Any) -> _models.EntityMutat 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. @@ -5515,29 +4826,23 @@ def add_classification( # pylint: disable=inconsistent-return-statements body = { "classification": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] }, "entityGuids": [ - "str" # Optional. The GUID of the entity. + "str" ] } """ @@ -5578,7 +4883,6 @@ def add_classification( # pylint: disable=inconsistent-return-statements 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] @@ -5595,33 +4899,27 @@ def add_classification( # pylint: disable=inconsistent-return-statements body = { "classification": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] }, "entityGuids": [ - "str" # Optional. The GUID of the entity. + "str" ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -5649,7 +4947,7 @@ def add_classification( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -5661,8 +4959,6 @@ def add_classification( # pylint: disable=inconsistent-return-statements 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) @@ -5679,7 +4975,6 @@ def get( 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. @@ -5701,206 +4996,151 @@ def get( response == { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -5921,7 +5161,7 @@ def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -5951,7 +5191,6 @@ def get( @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. @@ -5974,175 +5213,122 @@ def update_attribute_by_id(self, guid: str, body: Any, *, name: str, **kwargs: A # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6167,7 +5353,7 @@ def update_attribute_by_id(self, guid: str, body: Any, *, name: str, **kwargs: A params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6197,7 +5383,6 @@ def update_attribute_by_id(self, guid: str, body: Any, *, name: str, **kwargs: A @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. @@ -6212,175 +5397,122 @@ def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult: # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6399,7 +5531,7 @@ def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6429,7 +5561,6 @@ def delete(self, guid: str, **kwargs: Any) -> _models.EntityMutationResult: @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. @@ -6446,28 +5577,23 @@ def get_classification(self, guid: str, classification_name: str, **kwargs: Any) # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be active or - deleted. Deleted entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time boundary. - "startTime": "str", # Optional. The start of the time - boundary. - "timeZone": "str" # Optional. The timezone of the time - boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6487,7 +5613,7 @@ def get_classification(self, guid: str, classification_name: str, **kwargs: Any) params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6529,7 +5655,7 @@ def remove_classification( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6549,7 +5675,7 @@ def remove_classification( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6561,8 +5687,6 @@ def remove_classification( # pylint: disable=inconsistent-return-statements 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) @@ -6572,7 +5696,6 @@ def remove_classification( # pylint: disable=inconsistent-return-statements @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. @@ -6587,17 +5710,16 @@ def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasClassifi # 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. + {} + ], + "pageSize": 0, + "sortBy": "str", + "sortType": "str", + "startIndex": 0, + "totalCount": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6616,7 +5738,7 @@ def get_classifications(self, guid: str, **kwargs: Any) -> _models.AtlasClassifi params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6653,7 +5775,6 @@ def add_classifications( # pylint: disable=inconsistent-return-statements 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. @@ -6674,24 +5795,18 @@ def add_classifications( # pylint: disable=inconsistent-return-statements body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -6731,7 +5846,7 @@ def add_classifications( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6760,7 +5875,7 @@ def add_classifications( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6772,8 +5887,6 @@ def add_classifications( # pylint: disable=inconsistent-return-statements 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) @@ -6790,7 +5903,6 @@ def update_classifications( # pylint: disable=inconsistent-return-statements 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. @@ -6811,24 +5923,18 @@ def update_classifications( # pylint: disable=inconsistent-return-statements body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -6868,7 +5974,7 @@ def update_classifications( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -6897,7 +6003,7 @@ def update_classifications( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -6909,8 +6015,6 @@ def update_classifications( # pylint: disable=inconsistent-return-statements 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) @@ -6928,13 +6032,12 @@ def get_by_unique_attribute( 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:``. + attr:\\:code:``=:code:``. NOTE: The attrName and attrValue should be unique across entities, eg. @@ -6967,206 +6070,151 @@ def get_by_unique_attribute( response == { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -7188,7 +6236,7 @@ def get_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -7226,7 +6274,6 @@ def update_by_unique_attribute( 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. @@ -7266,201 +6313,146 @@ def update_by_unique_attribute( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -7468,170 +6460,117 @@ def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -7647,7 +6586,6 @@ def update_by_unique_attribute( 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. @@ -7686,170 +6624,117 @@ def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -7865,7 +6750,6 @@ def update_by_unique_attribute( 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. @@ -7904,170 +6788,117 @@ def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -8082,7 +6913,6 @@ def update_by_unique_attribute( 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. @@ -8119,201 +6949,146 @@ def update_by_unique_attribute( body = { "entity": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 }, "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } @@ -8321,175 +7096,122 @@ def update_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8519,7 +7241,7 @@ def update_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8551,12 +7273,11 @@ def update_by_unique_attribute( 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:``. + attr:\\:code:``=\\:code:``. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. @@ -8581,175 +7302,122 @@ def delete_by_unique_attribute( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8769,7 +7437,7 @@ def delete_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8816,7 +7484,7 @@ def remove_classification_by_unique_attribute( # pylint: disable=inconsistent-r :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8837,7 +7505,7 @@ def remove_classification_by_unique_attribute( # pylint: disable=inconsistent-r params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -8849,8 +7517,6 @@ def remove_classification_by_unique_attribute( # pylint: disable=inconsistent-r 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) @@ -8868,7 +7534,6 @@ def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-ret 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. @@ -8893,24 +7558,18 @@ def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-ret body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -8969,7 +7628,7 @@ def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-ret :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -8999,7 +7658,7 @@ def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-ret params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9011,8 +7670,6 @@ def add_classifications_by_unique_attribute( # pylint: disable=inconsistent-ret 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) @@ -9030,7 +7687,6 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- 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. @@ -9055,24 +7711,18 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- body = [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - can be - active or deleted. Deleted entities are not removed. Known values are: - "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency control. - "removePropagationsOnEntityDelete": bool, # Optional. Determines if - propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the time - boundary. - "startTime": "str", # Optional. The start of the - time boundary. - "timeZone": "str" # Optional. The timezone of the - time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } @@ -9131,7 +7781,7 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9161,7 +7811,7 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9173,8 +7823,6 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- 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) @@ -9186,7 +7834,6 @@ def update_classifications_unique_by_attribute( # pylint: disable=inconsistent- 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. @@ -9206,87 +7853,62 @@ def batch_set_classifications( "guidHeaderMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } } } # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -9310,7 +7932,7 @@ def batch_set_classifications( # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -9334,7 +7956,7 @@ def batch_set_classifications( # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ @@ -9342,7 +7964,6 @@ def batch_set_classifications( 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. @@ -9359,90 +7980,65 @@ def batch_set_classifications( "guidHeaderMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } } } # response body for status code(s): 200 response == [ - "str" # Optional. + "str" ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9470,7 +8066,7 @@ def batch_set_classifications( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9508,14 +8104,13 @@ def batch_get_by_unique_attributes( 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:`` + 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. @@ -9554,216 +8149,152 @@ def batch_get_by_unique_attributes( "entities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "relationshipAttributes": { - "str": {} # Optional. The attributes of - relationship. + "str": {} }, - "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. + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "businessAttributes": { - "str": {} # Optional. Business attributes. + "str": {} }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "collectionId": "str", # Optional. The collection ID of the - entity. + "collectionId": "str", "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "customAttributes": { - "str": "str" # Optional. Custom Attribute. + "str": "str" }, - "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. + "guid": "str", + "homeId": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "provenanceType": 0, + "proxy": bool, "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. + "str": {} + }, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9785,7 +8316,7 @@ def batch_get_by_unique_attributes( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9815,7 +8346,6 @@ def batch_get_by_unique_attributes( @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. @@ -9830,74 +8360,58 @@ def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeader: # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -9916,7 +8430,7 @@ def get_header(self, guid: str, **kwargs: Any) -> _models.AtlasEntityHeader: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -9967,7 +8481,7 @@ def remove_business_metadata( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = { "str": { - "str": {} # Optional. + "str": {} } } """ @@ -10005,7 +8519,7 @@ def remove_business_metadata( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10034,7 +8548,7 @@ def remove_business_metadata( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10046,8 +8560,6 @@ def remove_business_metadata( # pylint: disable=inconsistent-return-statements 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) @@ -10087,7 +8599,7 @@ def add_or_update_business_metadata( # pylint: disable=inconsistent-return-stat # JSON input template you can fill out and use as your body input. body = { "str": { - "str": {} # Optional. + "str": {} } } """ @@ -10142,7 +8654,7 @@ def add_or_update_business_metadata( # pylint: disable=inconsistent-return-stat :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10172,7 +8684,7 @@ def add_or_update_business_metadata( # pylint: disable=inconsistent-return-stat params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10184,8 +8696,6 @@ def add_or_update_business_metadata( # pylint: disable=inconsistent-return-stat 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) @@ -10223,7 +8733,7 @@ def remove_business_metadata_attributes( # pylint: disable=inconsistent-return- # JSON input template you can fill out and use as your body input. body = { - "str": {} # Optional. + "str": {} } """ @@ -10270,7 +8780,7 @@ def remove_business_metadata_attributes( # pylint: disable=inconsistent-return- :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10300,7 +8810,7 @@ def remove_business_metadata_attributes( # pylint: disable=inconsistent-return- params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10312,8 +8822,6 @@ def remove_business_metadata_attributes( # pylint: disable=inconsistent-return- 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) @@ -10351,7 +8859,7 @@ def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent- # JSON input template you can fill out and use as your body input. body = { - "str": {} # Optional. + "str": {} } """ @@ -10398,7 +8906,7 @@ def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent- :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10428,7 +8936,7 @@ def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent- params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10440,8 +8948,6 @@ def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent- 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) @@ -10450,14 +8956,14 @@ def add_or_update_business_metadata_attributes( # pylint: disable=inconsistent- return cls(pipeline_response, None, {}) # type: ignore @distributed_trace - def get_business_metadata_template(self, **kwargs: Any) -> bytes: + def get_business_metadata_template(self, **kwargs: Any) -> Iterator[bytes]: """Get the sample Template for uploading/creating bulk BusinessMetaData. - :return: bytes - :rtype: bytes + :return: Iterator[bytes] + :rtype: Iterator[bytes] :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10468,14 +8974,14 @@ def get_business_metadata_template(self, **kwargs: Any) -> bytes: _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[bytes] = kwargs.pop("cls", None) + cls: ClsType[Iterator[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), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10493,10 +8999,7 @@ def get_business_metadata_template(self, **kwargs: Any) -> bytes: error = _deserialize(_models.AtlasErrorResponse, response.json()) raise HttpResponseError(response=response, model=error) - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = response.read() + deserialized = response.iter_bytes() if cls: return cls(pipeline_response, deserialized, {}) # type: ignore @@ -10527,20 +9030,18 @@ def import_business_metadata( response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } @@ -10563,20 +9064,18 @@ def import_business_metadata(self, body: JSON, **kwargs: Any) -> _models.BulkImp response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } @@ -10606,25 +9105,23 @@ def import_business_metadata( response == { "failedImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ], "successImportInfoList": [ { - "childObjectName": "str", # Optional. childObjectName. - "importStatus": "str", # Optional. importStatus. Known - values are: "SUCCESS" and "FAILED". - "parentObjectName": "str", # Optional. parentObjectName. - "remarks": "str" # Optional. remarks. + "childObjectName": "str", + "importStatus": "str", + "parentObjectName": "str", + "remarks": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10649,7 +9146,7 @@ def import_business_metadata( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10699,7 +9196,7 @@ def remove_labels( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -10736,7 +9233,7 @@ def remove_labels( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10768,7 +9265,7 @@ def remove_labels( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10780,8 +9277,6 @@ def remove_labels( # pylint: disable=inconsistent-return-statements 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) @@ -10811,7 +9306,7 @@ def set_labels( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -10848,7 +9343,7 @@ def set_labels( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10880,7 +9375,7 @@ def set_labels( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -10892,8 +9387,6 @@ def set_labels( # pylint: disable=inconsistent-return-statements 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) @@ -10923,7 +9416,7 @@ def add_label( # pylint: disable=inconsistent-return-statements # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -10960,7 +9453,7 @@ def add_label( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -10992,7 +9485,7 @@ def add_label( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -11004,8 +9497,6 @@ def add_label( # pylint: disable=inconsistent-return-statements 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) @@ -11057,7 +9548,7 @@ def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-st # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -11137,7 +9628,7 @@ def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-st :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -11170,7 +9661,7 @@ def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-st params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -11182,8 +9673,6 @@ def remove_labels_by_unique_attribute( # pylint: disable=inconsistent-return-st 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) @@ -11237,7 +9726,7 @@ def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -11321,7 +9810,7 @@ def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -11354,7 +9843,7 @@ def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -11366,8 +9855,6 @@ def set_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state 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) @@ -11421,7 +9908,7 @@ def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state # JSON input template you can fill out and use as your body input. body = [ - "str" # Optional. + "str" ] """ @@ -11505,7 +9992,7 @@ def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -11538,7 +10025,7 @@ def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -11550,8 +10037,6 @@ def add_labels_by_unique_attribute( # pylint: disable=inconsistent-return-state 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) @@ -11568,7 +10053,6 @@ def move_entities_to_collection( content_type: str = "application/json", **kwargs: Any ) -> _models.EntityMutationResult: - # pylint: disable=line-too-long """Move existing entities to the target collection. :param body: Required. @@ -11588,178 +10072,124 @@ def move_entities_to_collection( # 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. + "str" ] } # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -11769,7 +10199,6 @@ def move_entities_to_collection( 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. @@ -11789,170 +10218,117 @@ def move_entities_to_collection( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -11962,7 +10338,6 @@ def move_entities_to_collection( 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. @@ -11982,170 +10357,117 @@ def move_entities_to_collection( # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } @@ -12155,7 +10477,6 @@ def move_entities_to_collection( 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. @@ -12172,183 +10493,129 @@ def move_entities_to_collection( # 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. + "str" ] } # response body for status code(s): 200 response == { "guidAssignments": { - "str": "str" # Optional. A map of GUID assignments with entities. + "str": "str" }, "mutatedEntities": { "str": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification - names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The - GUID of the entity. - "entityStatus": "str", # Optional. - Status of the entity - can be active or deleted. Deleted - entities are not removed. Known values are: "ACTIVE" and - "DELETED". - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", "removePropagationsOnEntityDelete": - bool, # Optional. Determines if propagations will be removed - on entity deletion. - "typeName": "str", # Optional. The - name of the type. + bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. + "endTime": "str", "startTime": "str", - # Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a - shell entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "status": "str", + "typeName": "str" } ] }, "partialUpdatedEntities": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12378,7 +10645,7 @@ def move_entities_to_collection( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12434,15 +10701,10 @@ def batch_get( 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'. + 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 @@ -12465,81 +10727,59 @@ def batch_get( { "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -12562,7 +10802,7 @@ def batch_get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -12594,7 +10834,6 @@ def batch_get( 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. @@ -12613,146 +10852,115 @@ def create( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @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. @@ -12771,70 +10979,55 @@ def create(self, body: JSON, *, content_type: str = "application/json", **kwargs 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -12842,7 +11035,6 @@ def create(self, body: JSON, *, content_type: str = "application/json", **kwargs 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. @@ -12861,76 +11053,60 @@ def create( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @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. @@ -12946,143 +11122,113 @@ def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kwargs: 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -13110,7 +11256,7 @@ def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kwargs: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -13142,7 +11288,6 @@ def create(self, body: Union[_models.AtlasGlossary, JSON, IO[bytes]], **kwargs: 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. @@ -13161,92 +11306,66 @@ def create_categories( body = [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] @@ -13254,92 +11373,66 @@ def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ @@ -13348,7 +11441,6 @@ def create_categories( 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. @@ -13367,92 +11459,66 @@ def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ @@ -13461,7 +11527,6 @@ def create_categories( 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 @@ -13478,96 +11543,70 @@ def create_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -13595,7 +11634,7 @@ def create_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -13627,7 +11666,6 @@ def create_categories( 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. @@ -13645,165 +11683,131 @@ def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -13811,7 +11815,6 @@ def create_category( 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. @@ -13829,83 +11832,66 @@ def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -13913,7 +11899,6 @@ def create_category( 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. @@ -13931,83 +11916,66 @@ def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -14015,7 +11983,6 @@ def create_category( 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. @@ -14030,168 +11997,134 @@ def create_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -14219,7 +12152,7 @@ def create_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -14249,7 +12182,6 @@ def create_category( @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. @@ -14264,86 +12196,69 @@ def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGlossary # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -14362,7 +12277,7 @@ def get_category(self, category_id: str, **kwargs: Any) -> _models.AtlasGlossary params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -14399,7 +12314,6 @@ def update_category( 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. @@ -14419,165 +12333,131 @@ def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -14585,7 +12465,6 @@ def update_category( 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. @@ -14605,83 +12484,66 @@ def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -14689,7 +12551,6 @@ def update_category( 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. @@ -14709,83 +12570,66 @@ def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -14793,7 +12637,6 @@ def update_category( 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. @@ -14810,168 +12653,134 @@ def update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15000,7 +12809,7 @@ def update_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15040,7 +12849,7 @@ def delete_category( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15059,7 +12868,7 @@ def delete_category( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15071,8 +12880,6 @@ def delete_category( # pylint: disable=inconsistent-return-statements 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) @@ -15084,7 +12891,6 @@ def delete_category( # pylint: disable=inconsistent-return-statements 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. @@ -15105,89 +12911,72 @@ def partial_update_category( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -15195,7 +12984,6 @@ def partial_update_category( 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. @@ -15217,83 +13005,66 @@ def partial_update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ @@ -15301,7 +13072,6 @@ def partial_update_category( 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. @@ -15320,86 +13090,69 @@ def partial_update_category( # 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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the glossary - object. - "shortDescription": "str", # Optional. The short version of description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15428,7 +13181,7 @@ def partial_update_category( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15488,19 +13241,16 @@ def get_related_categories( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15522,7 +13272,7 @@ def get_related_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15560,7 +13310,6 @@ def get_category_terms( 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. @@ -15581,19 +13330,17 @@ def get_category_terms( # 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -15615,7 +13362,7 @@ def get_category_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -15652,7 +13399,6 @@ def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -15671,666 +13417,512 @@ def create_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -16345,7 +13937,6 @@ def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -16364,333 +13955,256 @@ def create_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -16705,7 +14219,6 @@ def create_term( content_type: str = "application/json", **kwargs: Any ) -> _models.AtlasGlossaryTerm: - # pylint: disable=line-too-long """Create a glossary term. :param body: Required. @@ -16724,333 +14237,256 @@ def create_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -17064,7 +14500,6 @@ def create_term( 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. @@ -17080,671 +14515,517 @@ def create_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -17773,7 +15054,7 @@ def create_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -17803,7 +15084,6 @@ def create_term( @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. @@ -17817,338 +15097,261 @@ def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTerm: # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -18168,7 +15371,7 @@ def get_term(self, term_id: str, **kwargs: Any) -> _models.AtlasGlossaryTerm: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -18206,7 +15409,6 @@ def update_term( 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. @@ -18227,666 +15429,512 @@ def update_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -18902,7 +15950,6 @@ def update_term( 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. @@ -18923,333 +15970,256 @@ def update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -19265,7 +16235,6 @@ def update_term( 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. @@ -19286,333 +16255,256 @@ def update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -19627,7 +16519,6 @@ def update_term( 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. @@ -19645,671 +16536,517 @@ def update_term( # JSON input template you can fill out and use as your body input. body = { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -20340,7 +17077,7 @@ def update_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -20378,7 +17115,7 @@ def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: disable=i :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -20397,7 +17134,7 @@ def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: disable=i params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -20409,8 +17146,6 @@ def delete_term(self, term_id: str, **kwargs: Any) -> None: # pylint: disable=i 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) @@ -20428,7 +17163,6 @@ def partial_update_term( 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. @@ -20451,338 +17185,261 @@ def partial_update_term( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -20798,7 +17455,6 @@ def partial_update_term( 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. @@ -20821,333 +17477,256 @@ def partial_update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -21162,7 +17741,6 @@ def partial_update_term( 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. @@ -21182,338 +17760,261 @@ def partial_update_term( # response body for status code(s): 200 response == { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "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. + "lastModifiedTS": "str", + "typeName": "str" + }, + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the term, - which is map>. The key of the first layer map - is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active Directory - object Id. - "info": "str" # Optional. additional information to - describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", + "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -21544,7 +18045,7 @@ def partial_update_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -21581,7 +18082,6 @@ def create_terms( 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. @@ -21601,369 +18101,256 @@ def create_terms( # JSON input template you can fill out and use as your body input. body = [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -21972,369 +18359,256 @@ def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -22350,7 +18624,6 @@ def create_terms( 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. @@ -22370,369 +18643,256 @@ def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } @@ -22747,7 +18907,6 @@ def create_terms( 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 @@ -22765,375 +18924,262 @@ def create_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23163,7 +19209,7 @@ def create_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23201,7 +19247,6 @@ def get_entities_assigned_with_term( 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. @@ -23223,31 +19268,27 @@ def get_entities_assigned_with_term( # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23269,7 +19310,7 @@ def get_entities_assigned_with_term( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23306,7 +19347,6 @@ def assign_term_to_entities( # pylint: disable=inconsistent-return-statements 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. @@ -23332,26 +19372,22 @@ def assign_term_to_entities( # pylint: disable=inconsistent-return-statements # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] @@ -23402,7 +19438,7 @@ def assign_term_to_entities( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23431,7 +19467,7 @@ def assign_term_to_entities( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23443,8 +19479,6 @@ def assign_term_to_entities( # pylint: disable=inconsistent-return-statements 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) @@ -23461,7 +19495,6 @@ def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return 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. @@ -23482,26 +19515,22 @@ def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return # 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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "typeName": "str" # Optional. The name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } } ] @@ -23541,7 +19570,7 @@ def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23570,7 +19599,7 @@ def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23582,8 +19611,6 @@ def delete_term_assignment_from_entities( # pylint: disable=inconsistent-return 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) @@ -23601,7 +19628,6 @@ def get_related_terms( 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. @@ -23624,22 +19650,18 @@ def get_related_terms( 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23662,7 +19684,7 @@ def get_related_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23692,7 +19714,6 @@ def get_related_terms( @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. @@ -23708,73 +19729,58 @@ def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -23793,7 +19799,7 @@ def get(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -23831,7 +19837,6 @@ def update( 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. @@ -23855,140 +19860,110 @@ def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -24002,7 +19977,6 @@ def update( 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. @@ -24026,70 +20000,55 @@ def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -24103,7 +20062,6 @@ def update( 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. @@ -24127,70 +20085,55 @@ def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -24203,7 +20146,6 @@ def update( 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. @@ -24224,143 +20166,113 @@ def update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24391,7 +20303,7 @@ def update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24430,7 +20342,7 @@ def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disable=in :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24449,7 +20361,7 @@ def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disable=in params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24461,8 +20373,6 @@ def delete(self, glossary_id: str, **kwargs: Any) -> None: # pylint: disable=in 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) @@ -24480,7 +20390,6 @@ def get_categories( 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. @@ -24503,96 +20412,70 @@ def get_categories( response == [ { "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" }, - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. - "shortDescription": "str", # Optional. The short version of - description. + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "updateTime": 0, # Optional. The update time of the record. - "updatedBy": "str" # Optional. The user who updated the record. + "updateTime": 0, + "updatedBy": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24614,7 +20497,7 @@ def get_categories( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24673,17 +20556,15 @@ def get_categories_headers( # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -24705,7 +20586,7 @@ def get_categories_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -24735,7 +20616,6 @@ def get_categories_headers( @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. @@ -24758,587 +20638,379 @@ def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "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. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", "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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" + }, + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str" } }, "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "termInfo": { "str": { - "abbreviation": "str", # Optional. The abbreviation of the - term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the - glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The - attributes of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. - ETag for concurrency control. - "typeName": "str" # Optional. The - name of the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique - attributes of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes - of the term, which is map>. The key of - the first layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure - Active Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the - record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display - text. - "guid": "str", # Optional. The GUID of the - object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource - Id. - "typeName": "str", # Optional. The name of - the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique - attributes of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display - name for url. - "url": "str" # Optional. web url. http or - https. + "displayName": "str", + "url": "str" } ], "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". + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25358,7 +21030,7 @@ def get_detailed(self, glossary_id: str, **kwargs: Any) -> _models.AtlasGlossary params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25396,7 +21068,6 @@ def partial_update( 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. @@ -25426,77 +21097,62 @@ def partial_update( # JSON input template you can fill out and use as your body input. body = { - "str": "str" # Optional. + "str": "str" } # 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -25510,7 +21166,6 @@ def partial_update( 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. @@ -25542,70 +21197,55 @@ def partial_update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ @@ -25618,7 +21258,6 @@ def partial_update( 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. @@ -25647,73 +21286,58 @@ def partial_update( 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. + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "parentCategoryGuid": "str", + "relationGuid": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the struct. - }, - "entityGuid": "str", # Optional. The GUID of the entity. - "entityStatus": "str", # Optional. Status of the entity - - can be active or deleted. Deleted entities are not removed. Known values - are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. - "removePropagationsOnEntityDelete": bool, # Optional. - Determines if propagations will be removed on entity deletion. - "typeName": "str", # Optional. The name of the type. + "str": {} + }, + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The end of the - time boundary. - "startTime": "str", # Optional. The start of - the time boundary. - "timeZone": "str" # Optional. The timezone - of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "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. + "createTime": 0, + "createdBy": "str", + "guid": "str", + "language": "str", + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "qualifiedName": "str", + "shortDescription": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "updateTime": 0, + "updatedBy": "str", + "usage": "str" } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -25744,7 +21368,7 @@ def partial_update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -25782,7 +21406,6 @@ def get_terms( 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. @@ -25804,375 +21427,262 @@ def get_terms( # response body for status code(s): 200 response == [ { - "abbreviation": "str", # Optional. The abbreviation of the term. + "abbreviation": "str", "anchor": { - "displayText": "str", # Optional. The display text. - "glossaryGuid": "str", # Optional. The GUID of the glossary. - "relationGuid": "str" # Optional. The GUID of the - relationship. + "displayText": "str", + "glossaryGuid": "str", + "relationGuid": "str" }, "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "displayText": "str", + "entityStatus": "str", + "guid": "str", "relationshipAttributes": { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "typeName": "str" # Optional. The name of - the type. + "lastModifiedTS": "str", + "typeName": "str" }, - "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. + "relationshipGuid": "str", + "relationshipStatus": "str", + "relationshipType": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "attributes": { "str": { - "str": {} # Optional. The custom attributes of the - term, which is map>. The key of the first - layer map is term template name. + "str": {} } }, "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". + "categoryGuid": "str", + "description": "str", + "displayText": "str", + "relationGuid": "str", + "status": "str" } ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes of the - struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of the - entity. - "entityStatus": "str", # Optional. Status of the - entity - can be active or deleted. Deleted entities are not removed. - Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag for - concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # Optional. The - end of the time boundary. - "startTime": "str", # Optional. The - start of the time boundary. - "timeZone": "str" # Optional. The - timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "contacts": { "str": [ { - "id": "str", # Optional. Azure Active - Directory object Id. - "info": "str" # Optional. additional - information to describe this contact. + "id": "str", + "info": "str" } ] }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "examples": [ - "str" # Optional. An array of examples. + "str" ], - "guid": "str", # Optional. The GUID of the object. + "guid": "str", "hierarchyInfo": [ { - "displayText": "str", # Optional. Display text. - "guid": "str", # Optional. The GUID of the object. - "itemPath": "str", # Optional. Item path. - "name": "str", # Optional. Name. + "displayText": "str", + "guid": "str", + "itemPath": "str", + "name": "str", "properties": { - "str": {} # Optional. Dictionary of - :code:``. + "str": {} }, - "resourceId": "str", # Optional. Resource Id. - "typeName": "str", # Optional. The name of the type. + "resourceId": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes - of the object. + "str": {} } } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "lastModifiedTS": "str", + "longDescription": "str", + "name": "str", + "nickName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "qualifiedName": "str", # Optional. The qualified name of the - glossary object. + "qualifiedName": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "resources": [ { - "displayName": "str", # Optional. Display name for - url. - "url": "str" # Optional. web url. http or https. + "displayName": "str", + "url": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "shortDescription": "str", # Optional. The short version of - description. - "status": "str", # Optional. Status of the AtlasGlossaryTerm. Known - values are: "Draft", "Approved", "Alert", and "Expired". + "shortDescription": "str", + "status": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], - "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. + "updateTime": 0, + "updatedBy": "str", + "usage": "str", "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ], "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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26195,7 +21705,7 @@ def get_terms( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26233,7 +21743,6 @@ def get_term_headers( 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. @@ -26255,19 +21764,17 @@ def get_term_headers( # 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. + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -26289,7 +21796,7 @@ def get_term_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -26339,10 +21846,9 @@ def __init__(self, *args, **kwargs): 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. + :param body: Body parameter. 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". @@ -26356,43 +21862,33 @@ def query( # 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. + "continuationToken": "str", "facets": [ { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } ], - "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. + "filter": {}, + "keywords": "str", + "limit": 0, "orderby": [ - {} # Optional. The sort order of search results, can specify - multiple fields. + {} ], "taxonomySetting": { "assetTypes": [ - "str" # Optional. Asset types. + "str" ], "facet": { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } } @@ -26400,164 +21896,131 @@ def query( # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -26565,10 +22028,9 @@ def query( @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. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -26582,164 +22044,131 @@ def query(self, body: JSON, *, content_type: str = "application/json", **kwargs: # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -26747,10 +22176,9 @@ def query(self, body: JSON, *, content_type: str = "application/json", **kwargs: @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. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -26764,164 +22192,131 @@ def query(self, body: IO[bytes], *, content_type: str = "application/json", **kw # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -26929,10 +22324,10 @@ def query(self, body: IO[bytes], *, content_type: str = "application/json", **kw @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. + :param body: Body parameter. 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 @@ -26943,43 +22338,33 @@ def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: An # 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. + "continuationToken": "str", "facets": [ { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } ], - "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. + "filter": {}, + "keywords": "str", + "limit": 0, "orderby": [ - {} # Optional. The sort order of search results, can specify - multiple fields. + {} ], "taxonomySetting": { "assetTypes": [ - "str" # Optional. Asset types. + "str" ], "facet": { - "count": 0, # Optional. The count of the facet item. - "facet": "str", # Optional. The name of the facet item. + "count": 0, + "facet": "str", "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". + "count": "str", + "value": "str" } } } @@ -26987,169 +22372,136 @@ def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: An # 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.count": 0, + "@search.count.approximate": bool, "@search.facets": { "assetType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "classification": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactId": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "contactType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "entityType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "glossaryType": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "label": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "term": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termStatus": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ], "termTemplate": [ { - "count": 0, # Optional. The count of the facet item. - "value": "str" # Optional. The name of the facet - item. + "count": 0, + "value": "str" } ] }, - "continuationToken": "str", # Optional. The token used to get next batch of - data. Absent if there's no more data. + "continuationToken": "str", "value": [ { "@search.highlights": { "description": [ - "str" # Optional. Description. + "str" ], "entityType": [ - "str" # Optional. Entity type. + "str" ], "id": [ - "str" # Optional. Id. + "str" ], "name": [ - "str" # Optional. Name. + "str" ], "qualifiedName": [ - "str" # Optional. Qualified name. + "str" ] }, - "@search.score": 0.0, # Optional. The search score - calculated by the search engine. The results are ordered by search score - by default. + "@search.score": 0.0, "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27178,7 +22530,7 @@ def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: An params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27210,10 +22562,9 @@ def query(self, body: Union[_models.QueryOptions, JSON, IO[bytes]], **kwargs: An 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. + :param body: Body parameter. 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". @@ -27227,83 +22578,57 @@ def suggest( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -27311,10 +22636,9 @@ def suggest( @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. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -27330,70 +22654,48 @@ def suggest(self, body: JSON, *, content_type: str = "application/json", **kwarg 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -27403,10 +22705,9 @@ def suggest(self, body: JSON, *, content_type: str = "application/json", **kwarg 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. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -27422,70 +22723,48 @@ def suggest( 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } @@ -27493,10 +22772,10 @@ def suggest( @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. + :param body: Body parameter. 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 @@ -27507,88 +22786,62 @@ def suggest(self, body: Union[_models.SuggestOptions, JSON, IO[bytes]], **kwargs # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "@search.score": 0.0, + "@search.text": "str", "assetType": [ - "str" # Optional. The asset types of the asset. + "str" ], "classification": [ - "str" # Optional. The classifications of the record. + "str" ], "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. + "contactType": "str", + "id": "str", + "info": "str" + } + ], + "createTime": 0, + "description": "str", + "endorsement": "str", + "entityType": "str", + "glossary": "str", + "glossaryType": "str", + "id": "str", "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. + "str" + ], + "longDescription": "str", + "name": "str", + "objectType": "str", + "owner": "str", + "qualifiedName": "str", "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. + "glossaryName": "str", + "guid": "str", + "name": "str" } ], - "termStatus": "str", # Optional. The status of the term. + "termStatus": "str", "termTemplate": [ - "str" # Optional. The term template names used by - the term. + "str" ], - "updateTime": 0 # Optional. The last update time of the - record. The Unix epoch format. + "updateTime": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27617,7 +22870,7 @@ def suggest(self, body: Union[_models.SuggestOptions, JSON, IO[bytes]], **kwargs params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27649,10 +22902,9 @@ def suggest(self, body: Union[_models.SuggestOptions, JSON, IO[bytes]], **kwargs 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. + :param body: Body parameter. 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". @@ -27666,21 +22918,17 @@ def auto_complete( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "queryPlusText": "str", + "text": "str" } ] } @@ -27692,7 +22940,7 @@ def auto_complete( ) -> _models.AutoCompleteResult: """Get auto complete options. - :param body: Required. + :param body: Body parameter. Required. :type body: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". @@ -27708,9 +22956,8 @@ def auto_complete( response == { "value": [ { - "queryPlusText": "str", # Optional. The completed search - query text. - "text": "str" # Optional. The completed term or phrase. + "queryPlusText": "str", + "text": "str" } ] } @@ -27722,7 +22969,7 @@ def auto_complete( ) -> _models.AutoCompleteResult: """Get auto complete options. - :param body: Required. + :param body: Body parameter. Required. :type body: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". @@ -27738,9 +22985,8 @@ def auto_complete( response == { "value": [ { - "queryPlusText": "str", # Optional. The completed search - query text. - "text": "str" # Optional. The completed term or phrase. + "queryPlusText": "str", + "text": "str" } ] } @@ -27750,10 +22996,10 @@ def auto_complete( 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. + :param body: Body parameter. 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 @@ -27764,26 +23010,22 @@ def auto_complete( # 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. + "filter": {}, + "keywords": "str", + "limit": 0 } # 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. + "queryPlusText": "str", + "text": "str" } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -27812,7 +23054,7 @@ def auto_complete( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -27862,7 +23104,6 @@ def __init__(self, *args, **kwargs): 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. @@ -27881,118 +23122,87 @@ def get( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28013,7 +23223,7 @@ def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28051,7 +23261,6 @@ def get_next_page( 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. @@ -28072,118 +23281,87 @@ def get_next_page( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28206,7 +23384,7 @@ def get_next_page( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28244,7 +23422,6 @@ def get_by_unique_attribute( 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, @@ -28282,118 +23459,87 @@ def get_by_unique_attribute( # 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. + "baseEntityGuid": "str", + "childrenCount": 0, "guidEntityMap": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, - "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. + "lineageDepth": 0, + "lineageDirection": "str", + "lineageWidth": 0, "parentRelations": [ { - "childEntityId": "str", # Optional. The GUID of child - entity. - "parentEntityId": "str", # Optional. The GUID of parent - entity. - "relationshipId": "str" # Optional. The GUID of - relationship. + "childEntityId": "str", + "parentEntityId": "str", + "relationshipId": "str" } ], "relations": [ { - "fromEntityId": "str", # Optional. The GUID of from-entity. - "relationshipId": "str", # Optional. The GUID of - relationship. - "toEntityId": "str" # Optional. The GUID of to-entity. + "fromEntityId": "str", + "relationshipId": "str", + "toEntityId": "str" } ], "widthCounts": { "str": { - "str": {} # Optional. The entity count in specific - direction. + "str": {} } } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28415,7 +23561,7 @@ def get_by_unique_attribute( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28482,71 +23628,67 @@ def create( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -28569,36 +23711,34 @@ def create(self, body: JSON, *, content_type: str = "application/json", **kwargs # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -28623,36 +23763,34 @@ def create( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -28674,74 +23812,70 @@ def create( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -28769,7 +23903,7 @@ def create( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -28818,71 +23952,67 @@ def update( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -28905,36 +24035,34 @@ def update(self, body: JSON, *, content_type: str = "application/json", **kwargs # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -28959,36 +24087,34 @@ def update( # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ @@ -29010,74 +24136,70 @@ def update( # JSON input template you can fill out and use as your body input. body = { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } # response body for status code(s): 200 response == { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29105,7 +24227,7 @@ def update( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29137,7 +24259,6 @@ def update( 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. @@ -29157,120 +24278,91 @@ def get( "referredEntities": { "str": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, "classificationNames": [ - "str" # Optional. An array of classification names. + "str" ], "classifications": [ { "attributes": { - "str": {} # Optional. The attributes - of the struct. + "str": {} }, - "entityGuid": "str", # Optional. The GUID of - the entity. - "entityStatus": "str", # Optional. Status of - the entity - can be active or deleted. Deleted entities are not - removed. Known values are: "ACTIVE" and "DELETED". - "lastModifiedTS": "str", # Optional. ETag - for concurrency control. - "removePropagationsOnEntityDelete": bool, # - Optional. Determines if propagations will be removed on entity - deletion. - "typeName": "str", # Optional. The name of - the type. + "entityGuid": "str", + "entityStatus": "str", + "lastModifiedTS": "str", + "removePropagationsOnEntityDelete": bool, + "typeName": "str", "validityPeriods": [ { - "endTime": "str", # - Optional. The end of the time boundary. - "startTime": "str", # - Optional. The start of the time boundary. - "timeZone": "str" # - Optional. The timezone of the time boundary. + "endTime": "str", + "startTime": "str", + "timeZone": "str" } ] } ], - "displayText": "str", # Optional. The display text. - "guid": "str", # Optional. The GUID of the record. - "isIncomplete": bool, # Optional. Whether it is a shell - entity. + "displayText": "str", + "guid": "str", + "isIncomplete": bool, "labels": [ - "str" # Optional. labels. + "str" ], - "lastModifiedTS": "str", # Optional. ETag for concurrency - control. + "lastModifiedTS": "str", "meaningNames": [ - "str" # Optional. An array of meanings. + "str" ], "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. + "confidence": 0, + "createdBy": "str", + "description": "str", + "displayText": "str", + "expression": "str", + "relationGuid": "str", + "status": "str", + "steward": "str", + "termGuid": "str" + } + ], + "status": "str", + "typeName": "str" } }, "relationship": { "attributes": { - "str": {} # Optional. The attributes of the struct. + "str": {} }, - "createTime": 0, # Optional. The created time of the record. - "createdBy": "str", # Optional. The user who created the record. + "createTime": 0, + "createdBy": "str", "end1": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } }, "end2": { - "guid": "str", # Optional. The GUID of the object. - "typeName": "str", # Optional. The name of the type. + "guid": "str", + "typeName": "str", "uniqueAttributes": { - "str": {} # Optional. The unique attributes of the - object. + "str": {} } }, - "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. + "guid": "str", + "homeId": "str", + "label": "str", + "lastModifiedTS": "str", + "provenanceType": 0, + "status": "str", + "typeName": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29290,7 +24382,7 @@ def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29328,7 +24420,7 @@ def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inconsist :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29347,7 +24439,7 @@ def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inconsist params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29359,8 +24451,6 @@ def delete(self, guid: str, **kwargs: Any) -> None: # pylint: disable=inconsist 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) @@ -29388,7 +24478,6 @@ def __init__(self, *args, **kwargs): @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. @@ -29405,111 +24494,87 @@ def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models.Atlas response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29528,7 +24593,7 @@ def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models.Atlas params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29558,7 +24623,6 @@ def get_business_metadata_by_id(self, guid: str, **kwargs: Any) -> _models.Atlas @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. @@ -29575,111 +24639,87 @@ def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _models.Atl response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29698,7 +24738,7 @@ def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _models.Atl params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29728,7 +24768,6 @@ def get_business_metadata_by_name(self, name: str, **kwargs: Any) -> _models.Atl @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. @@ -29744,130 +24783,96 @@ def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasCla response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -29886,7 +24891,7 @@ def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasCla params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -29916,7 +24921,6 @@ def get_classification_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasCla @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. @@ -29932,130 +24936,96 @@ def get_classification_by_name(self, name: str, **kwargs: Any) -> _models.AtlasC response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30074,7 +25044,7 @@ def get_classification_by_name(self, name: str, **kwargs: Any) -> _models.AtlasC params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -30104,7 +25074,6 @@ def get_classification_by_name(self, name: str, **kwargs: Any) -> _models.AtlasC @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. @@ -30120,158 +25089,121 @@ def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntityDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30290,7 +25222,7 @@ def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntityDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -30320,7 +25252,6 @@ def get_entity_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEntityDef: @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. @@ -30336,158 +25267,121 @@ def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEntityDef response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30506,7 +25400,7 @@ def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEntityDef params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -30536,7 +25430,6 @@ def get_entity_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEntityDef @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. @@ -30550,87 +25443,71 @@ def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef: # 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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30649,7 +25526,7 @@ def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -30679,7 +25556,6 @@ def get_enum_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasEnumDef: @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. @@ -30693,87 +25569,71 @@ def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumDef: # 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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30792,7 +25652,7 @@ def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -30822,7 +25682,6 @@ def get_enum_by_name(self, name: str, **kwargs: Any) -> _models.AtlasEnumDef: @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. @@ -30838,144 +25697,105 @@ def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasRelat response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -30994,7 +25814,7 @@ def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasRelat params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31024,7 +25844,6 @@ def get_relationship_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasRelat @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. @@ -31040,144 +25859,105 @@ def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.AtlasRel response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "description": "str", # Optional. The description of the type definition. + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -31196,7 +25976,7 @@ def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.AtlasRel params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31226,7 +26006,6 @@ def get_relationship_by_name(self, name: str, **kwargs: Any) -> _models.AtlasRel @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. @@ -31242,111 +26021,87 @@ def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStructDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -31365,7 +26120,7 @@ def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStructDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31395,7 +26150,6 @@ def get_struct_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasStructDef: @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. @@ -31411,111 +26165,87 @@ def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStructDef response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -31534,7 +26264,7 @@ def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStructDef params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31564,7 +26294,6 @@ def get_struct_by_name(self, name: str, **kwargs: Any) -> _models.AtlasStructDef @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. @@ -31580,215 +26309,150 @@ def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "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. + "str": "str" + }, + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -31807,7 +26471,7 @@ def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -31837,7 +26501,6 @@ def get_by_id(self, guid: str, **kwargs: Any) -> _models.AtlasTypeDef: @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. @@ -31853,215 +26516,150 @@ def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "defaultValue": "str", # Optional. The default value. - "description": "str", # Optional. The description of the type definition. + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "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. + "str": "str" + }, + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -32080,7 +26678,7 @@ def get_by_name(self, name: str, **kwargs: Any) -> _models.AtlasTypeDef: params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -32118,7 +26716,7 @@ def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsist :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -32137,7 +26735,7 @@ def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsist params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -32149,8 +26747,6 @@ def delete(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsist 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) @@ -32166,7 +26762,6 @@ def get( 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. @@ -32190,948 +26785,636 @@ def get( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -33152,7 +27435,7 @@ def get( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -33184,10 +27467,7 @@ def get( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: ~azure.purview.datamap.models.AtlasTypesDef @@ -33207,943 +27487,631 @@ def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -34154,943 +28122,631 @@ def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -35100,10 +28756,7 @@ def batch_create( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: JSON @@ -35123,943 +28776,631 @@ def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -36069,10 +29410,7 @@ def batch_create( 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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :param body: Required. :type body: IO[bytes] @@ -36092,943 +29430,631 @@ def batch_create( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", + "options": { + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -37036,10 +30062,7 @@ def batch_create( @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. + """Create all atlas type definitions in bulk. Please avoid recreating existing types. :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] @@ -37056,943 +30079,631 @@ def batch_create(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -38003,948 +30714,636 @@ def batch_create(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -38972,7 +31371,7 @@ def batch_create(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -39004,7 +31403,6 @@ def batch_create(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw 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. @@ -39026,943 +31424,631 @@ def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -39973,943 +32059,631 @@ def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -40919,7 +32693,6 @@ def batch_update( 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. @@ -40941,943 +32714,631 @@ def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -41887,7 +33348,6 @@ def batch_update( 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. @@ -41909,943 +33369,631 @@ def batch_update( { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -42853,7 +34001,6 @@ def batch_update( @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. @@ -42872,943 +34019,631 @@ def batch_update(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -43819,948 +34654,636 @@ def batch_update(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -44788,7 +35311,7 @@ def batch_update(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -44820,7 +35343,6 @@ def batch_update(self, body: Union[_models.AtlasTypesDef, JSON, IO[bytes]], **kw 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. @@ -44841,943 +35363,631 @@ def batch_delete( # pylint: disable=inconsistent-return-statements { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } @@ -45819,7 +36029,6 @@ def batch_delete( # pylint: disable=inconsistent-return-statements 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. @@ -45837,948 +36046,636 @@ def batch_delete( # pylint: disable=inconsistent-return-statements { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "classificationDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "str" + ], + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "entityDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, "relationshipAttributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isLegacyAttribute": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "relationshipTypeName": "str", + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "serviceType": "str", # Optional. The service type. + "serviceType": "str", "subTypes": [ - "str" # Optional. An array of sub types. + "str" ], "superTypes": [ - "str" # Optional. An array of super types. + "str" ], - "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. + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "defaultValue": "str", + "description": "str", "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. + "description": "str", + "ordinal": 0, + "value": "str" } ], - "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. + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "relationshipDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" }, "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. + "cardinality": "str", + "description": "str", + "isContainer": bool, + "isLegacyAttribute": bool, + "name": "str", + "type": "str" + }, + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "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. + "str": "str" + }, + "relationshipCategory": "str", + "relationshipLabel": "str", + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "structDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ], "termTemplateDefs": [ { "attributeDefs": [ { - "cardinality": "str", # Optional. - single-valued attribute or multi-valued attribute. Known values - are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # - Optional. The parameters of the constraint - definition. + "str": {} }, - "type": "str" # Optional. - The type of the constraint. + "type": "str" } ], - "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. + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options - for the attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 + } + ], + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available - locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency - of the date format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines - if grouping is used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. - Determines if only integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum - of rounding mode. Known values are: "UP", "DOWN", "CEILING", - "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of - available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 + } + }, + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type - definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } ] } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -46806,7 +36703,7 @@ def batch_delete( # pylint: disable=inconsistent-return-statements params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -46818,8 +36715,6 @@ def batch_delete( # pylint: disable=inconsistent-return-statements 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) @@ -46835,7 +36730,6 @@ def get_headers( 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. @@ -46856,16 +36750,13 @@ def get_headers( # 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. + "category": "str", + "guid": "str", + "name": "str" } ] """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -46886,7 +36777,7 @@ def get_headers( params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -46916,7 +36807,6 @@ def get_headers( @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. @@ -46932,111 +36822,87 @@ def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.TermTempl response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -47056,7 +36922,7 @@ def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.TermTempl params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -47086,7 +36952,6 @@ def get_term_template_by_id(self, guid: str, **kwargs: Any) -> _models.TermTempl @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. @@ -47102,111 +36967,87 @@ def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.TermTem response == { "attributeDefs": [ { - "cardinality": "str", # Optional. single-valued attribute or - multi-valued attribute. Known values are: "SINGLE", "LIST", and "SET". + "cardinality": "str", "constraints": [ { "params": { - "str": {} # Optional. The parameters - of the constraint definition. + "str": {} }, - "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. + "type": "str" + } + ], + "defaultValue": "str", + "description": "str", + "includeInNotification": bool, + "isIndexable": bool, + "isOptional": bool, + "isUnique": bool, + "name": "str", "options": { - "str": "str" # Optional. The options for the - attribute. + "str": "str" }, - "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. + "typeName": "str", + "valuesMaxCount": 0, + "valuesMinCount": 0 } ], - "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. + "category": "str", + "createTime": 0, + "createdBy": "str", "dateFormatter": { "availableLocales": [ - "str" # Optional. An array of available locales. + "str" ], - "calendar": 0.0, # Optional. Calendar. + "calendar": 0.0, "dateInstance": ..., "dateTimeInstance": ..., "instance": ..., - "lenient": bool, # Optional. Determines the leniency of the date - format. + "lenient": bool, "numberFormat": { "availableLocales": [ - "str" # Optional. The number format. + "str" ], - "currency": "str", # Optional. The currency. + "currency": "str", "currencyInstance": ..., - "groupingUsed": bool, # Optional. Determines if grouping is - used. + "groupingUsed": bool, "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. + "maximumFractionDigits": 0, + "maximumIntegerDigits": 0, + "minimumFractionDigits": 0, + "minimumIntegerDigits": 0, "numberInstance": ..., - "parseIntegerOnly": bool, # Optional. Determines if only - integer is parsed. + "parseIntegerOnly": bool, "percentInstance": ..., - "roundingMode": "str" # Optional. The enum of rounding mode. - Known values are: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", - "HALF_DOWN", "HALF_EVEN", and "UNNECESSARY". + "roundingMode": "str" }, "timeInstance": ..., "timeZone": { "availableIds": [ - "str" # Optional. An array of available IDs. + "str" ], "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. + "displayName": "str", + "dstSavings": 0, + "id": "str", + "rawOffset": 0 } }, - "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. + "description": "str", + "guid": "str", + "lastModifiedTS": "str", + "name": "str", "options": { - "str": "str" # Optional. The options for the type definition. + "str": "str" }, - "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. + "serviceType": "str", + "typeVersion": "str", + "updateTime": 0, + "updatedBy": "str", + "version": 0 } """ - error_map = { + error_map: MutableMapping[int, Type[HttpResponseError]] = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -47226,7 +37067,7 @@ def get_term_template_by_name(self, name: str, **kwargs: Any) -> _models.TermTem params=_params, ) 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"), } _request.url = self._client.format_url(_request.url, **path_format_arguments) diff --git a/sdk/purview/azure-purview-datamap/samples/get_types.py b/sdk/purview/azure-purview-datamap/samples/get_types.py index 61d41f716315c..b5718163c8e8d 100644 --- a/sdk/purview/azure-purview-datamap/samples/get_types.py +++ b/sdk/purview/azure-purview-datamap/samples/get_types.py @@ -13,14 +13,11 @@ tenantId = os.environ["PURVIEW_TENANT_ID"] clientId = os.environ["PURVIEW_CLIENT_ID"] clientSecret = os.environ["PURVIEW_CLIENT_SECRET"] - authority = os.environ["AUTHORITY_HOST"] #e.g"https://login.microsoftonline.com/" + authority = os.environ["AUTHORITY_HOST"] # e.g"https://login.microsoftonline.com/" except KeyError: LOG.error("Missing environment variable - please set if before running the example") exit() -credential = ClientSecretCredential(tenantId, clientId, clientSecret,authority = authority) +credential = ClientSecretCredential(tenantId, clientId, clientSecret, authority=authority) client = DataMapClient(endpoint=endpoint, credential=credential) response = client.type_definition.get() - - - 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 0000000000000..e7687fdae93bc --- /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 index 2f897189a3b7c..c4b15c7a9e183 100644 --- a/sdk/purview/azure-purview-datamap/setup.py +++ b/sdk/purview/azure-purview-datamap/setup.py @@ -63,8 +63,8 @@ "azure.purview.datamap": ["py.typed"], }, install_requires=[ - "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.30.0", + "isodate>=0.6.1", + "azure-core>=1.30.0", "typing-extensions>=4.6.0", ], python_requires=">=3.8", diff --git a/sdk/purview/azure-purview-datamap/tests/conftest.py b/sdk/purview/azure-purview-datamap/tests/conftest.py index d7bbeda5fc54e..b75ef5fcdb00e 100644 --- a/sdk/purview/azure-purview-datamap/tests/conftest.py +++ b/sdk/purview/azure-purview-datamap/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("PURVIEWDATAMAP_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") diff --git a/sdk/purview/azure-purview-datamap/tests/test_smoke.py b/sdk/purview/azure-purview-datamap/tests/test_smoke.py index fa19f82bdf1b2..1dccd63b04ba7 100644 --- a/sdk/purview/azure-purview-datamap/tests/test_smoke.py +++ b/sdk/purview/azure-purview-datamap/tests/test_smoke.py @@ -8,6 +8,7 @@ from urllib.parse import urlparse from devtools_testutils import recorded_by_proxy + class TestDataMapSmoke(DataMapTest): @DataMapPowerShellPreparer() @recorded_by_proxy @@ -16,6 +17,14 @@ def test_basic_smoke_test(self, purviewdatamap_endpoint): assert client is not None response = client.type_definition.get() # cspell: disable-next-line - assert set(response.keys()) == set(['enumDefs', 'structDefs', 'classificationDefs', 'entityDefs', 'relationshipDefs','businessMetadataDefs','termTemplateDefs']) - - + assert set(response.keys()) == set( + [ + "enumDefs", + "structDefs", + "classificationDefs", + "entityDefs", + "relationshipDefs", + "businessMetadataDefs", + "termTemplateDefs", + ] + ) diff --git a/sdk/purview/azure-purview-datamap/tests/testcase.py b/sdk/purview/azure-purview-datamap/tests/testcase.py index dcbc1f89069ac..84e025c91110f 100644 --- a/sdk/purview/azure-purview-datamap/tests/testcase.py +++ b/sdk/purview/azure-purview-datamap/tests/testcase.py @@ -21,7 +21,5 @@ def create_client(self, endpoint): DataMapPowerShellPreparer = functools.partial( - PowerShellPreparer, - "purviewdatamap", - purviewdatamap_endpoint="https://fakeaccount.purview.azure.com" + PowerShellPreparer, "purviewdatamap", purviewdatamap_endpoint="https://fakeaccount.purview.azure.com" ) diff --git a/sdk/purview/azure-purview-datamap/tsp-location.yaml b/sdk/purview/azure-purview-datamap/tsp-location.yaml index 6a76c87decef5..26aadda1f1297 100644 --- a/sdk/purview/azure-purview-datamap/tsp-location.yaml +++ b/sdk/purview/azure-purview-datamap/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/purview/Azure.Analytics.Purview.DataMap -commit: e4dd3e7e4d0402a81b2bef7dd754d3e46e8a8ab5 +commit: 228acac22c34fa19cd629ba2df005822ab8ba959 repo: Azure/azure-rest-api-specs additionalDirectories: