pyegeria 0.8.4.10__py3-none-any.whl → 0.8.4.11__py3-none-any.whl

pyegeria/classification_manager_omvs.py

@@ -558,7 +558,81 @@ class ClassificationManager(Client):
         )
         return response
 
-    async def _async_get_guid_for_name(
+    async def _async_get_element_by_unique_name(
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
+    ) -> list | str:
+        """
+        Retrieve the metadata element using the supplied unique element name (typically the qualifiedName,
+        but it is possible to specify a different property name in the request body as long as its unique.
+        If more than one element returned, an exception is thrown. Async version.
+
+        Parameters
+        ----------
+        name: str
+            - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        str
+            Returns the guid of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+        if server_name is None:
+            server_name = self.server_name
+        property_name = "qualifiedName" if property_name is None else property_name
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "NameRequestBody",
+            "name": name,
+            "namePropertyName": property_name,
+            "forLineage": for_lineage,
+            "forDuplicateProcessing": for_duplicate_processing,
+            "effectiveTime": effective_time,
+        }
+
+        url = f"{base_path(self, server_name)}/elements/by-unique-name{possible_query_params}"
+
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body), time_out=time_out
+        )
+
+        return response.json().get("element", "No elements found")
+
+    def get_element_by_unique_name(
         self,
         name: str,
         property_name: str = None,
@@ -567,6 +641,67 @@ class ClassificationManager(Client):
         effective_time: str = None,
         server_name: str = None,
         time_out: int = default_time_out,
+    ) -> list | str:
+        """
+        Retrieve the metadata element using the supplied unique element name (typically the qualifiedName,
+        but it is possible to specify a different property name in the request body as long as its unique.
+        If more than one element returned, an exception is thrown.
+
+        Parameters
+        ----------
+        name: str
+            - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        str
+            Returns the guid of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_element_by_unique_name(
+                name,
+                property_name,
+                for_lineage,
+                for_duplicate_processing,
+                effective_time,
+                server_name,
+                time_out,
+            )
+        )
+        return response
+
+    async def _async_get_element_guid_by_unique_name(
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
     ) -> list | str:
         """
         Retrieve the guid associated with the supplied unique element name.
@@ -617,9 +752,9 @@ class ClassificationManager(Client):
         body = {
             "class": "NameRequestBody",
             "name": name,
+            "namePropertyName": property_name,
             "forLineage": for_lineage,
             "forDuplicateProcessing": for_duplicate_processing,
-            "namePropertyName": property_name,
             "effectiveTime": effective_time,
         }
 
@@ -629,18 +764,9 @@ class ClassificationManager(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elements", "No elements found")
+        return response.json().get("guid", "No elements found")
 
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-            elif len(elements) > 1:
-                raise Exception("Multiple elements found for supplied name!")
-            elif len(elements) == 1:
-                return elements[0]["elementHeader"]["guid"]
-        return elements
-
-    def get_guid_for_name(
+    def get_element_guid_by_unique_name(
         self,
         name: str,
         property_name: str = None,
@@ -688,7 +814,7 @@ class ClassificationManager(Client):
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_guid_for_name(
+            self._async_get_element_guid_by_unique_name(
                 name,
                 property_name,
                 for_lineage,
@@ -700,6 +826,89 @@ class ClassificationManager(Client):
         )
         return response
 
+    async def _async_get_guid_for_name(
+        self, name: str, server_name: str = None, time_out: int = default_time_out
+    ) -> list | str:
+        """
+        Retrieve the guid associated with the supplied element name.
+        If more than one element returned, an exception is thrown. Async version.
+
+        Parameters
+        ----------
+        name: str
+            - element name to be searched.
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        str
+            Returns the guid of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+        if server_name is None:
+            server_name = self.server_name
+        property_name = ["name", "qualifiedName", "title"]
+        elements = await self._async_get_elements_by_property_value(
+            name, property_name, None
+        )
+
+        if type(elements) is list:
+            if len(elements) == 0:
+                return "No elements found"
+            elif len(elements) > 1:
+                raise Exception("Multiple elements found for supplied name!")
+            elif len(elements) == 1:
+                return elements[0]["elementHeader"]["guid"]
+        return elements
+
+    def get_guid_for_name(
+        self, name: str, server_name: str = None, time_out: int = default_time_out
+    ) -> list | str:
+        """
+        Retrieve the guid associated with the supplied element name.
+        If more than one element returned, an exception is thrown.
+
+        Parameters
+        ----------
+        name: str
+            - element name to be searched.
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        str
+            Returns the guid of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_guid_for_name(name, server_name, time_out)
+        )
+        return response
+
     async def _async_find_elements_by_property_value(
         self,
         property_value: str,

pyegeria/runtime_manager_omvs.py

@@ -1043,9 +1043,102 @@ class RuntimeManager(Client):
         )
         return response
 
+    async def _async_add_archive_file(
+        self,
+        archive_file: str,
+        server_guid: str,
+        view_server: str = None,
+        time_out: int = 60,
+    ) -> None:
+        """Add a new open metadata archive to running OMAG Server's repository.
+            An open metadata archive contains metadata types and instances.  This operation loads an open metadata archive
+            that is stored in the named file.  It can be used with OMAG servers that are of type Open Metadata Store.
+            Async version.
+
+            https://egeria-project.org/concepts/open-metadata-archives/
+
+        Parameters
+        ----------
+        archive_file: str
+            Open metadata archive file to load.
+        server_guid: str
+            GUID of the server to load the file into.
+        server : str, optional
+           The name of the view server to work with. If not provided, the default server name
+           will be used.
+        time_out: int, optional
+           Time out for the rest call.
+
+        Returns
+        -------
+        Response
+          None
+
+        Raises
+        ------
+        InvalidParameterException
+        PropertyServerException
+        UserNotAuthorizedException
+
+        """
+        if view_server is None:
+            server = self.server_name
+
+        url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/omag-servers/{server_guid}/instance/load/open-metadata-archives/file"
+
+        await self._async_make_request(
+            "POST-DATA", url, archive_file, time_out=time_out
+        )
+        return
+
+    def add_archive_file(
+        self,
+        archive_file: str,
+        server_guid: str,
+        view_server: str = None,
+        time_out: int = 60,
+    ) -> None:
+        """Add a new open metadata archive to running OMAG Server's repository.
+            An open metadata archive contains metadata types and instances.  This operation loads an open metadata archive
+            that is stored in the named file.  It can be used with OMAG servers that are of type Open Metadata Store.
+
+            https://egeria-project.org/concepts/open-metadata-archives/
+
+        Parameters
+        ----------
+        archive_file: str
+            Open metadata archive file to load.
+        server_guid: str
+            GUID of the server to load the file into.
+        server : str, optional
+           The name of the view server to work with. If not provided, the default server name
+           will be used.
+
+        Returns
+        -------
+        Response
+           None
+
+        Raises
+        ------
+        InvalidParameterException
+        PropertyServerException
+        UserNotAuthorizedException
+
+        """
+
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_add_archive_file(
+                archive_file, server_guid, view_server, time_out
+            )
+        )
+        return
+
     #
     #   Activate
     #
+
     async def _async_activate_with_stored_config(
         self, server_guid: str, server: str = None
     ) -> None:
@@ -1066,6 +1159,33 @@ class RuntimeManager(Client):
         None
 
 
+        Raises
+        ------
+        InvalidParameterException
+        PropertyServerException
+        UserNotAuthorizedException
+
+        """
+        pass
+
+    def activate_with_stored_config(self, server_guid: str, server: str = None) -> None:
+        """Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this
+        server. Async Version
+
+        Parameters
+        ----------
+        server_guid: str
+            Identity of the server to activate.
+
+        server : str, optional
+           The name of the server to get governance engine summaries from. If not provided, the default server name
+           will be used.
+
+        Returns
+        -------
+        None
+
+
         Raises
         ------
         InvalidParameterException

{pyegeria-0.8.4.10.dist-info → pyegeria-0.8.4.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.8.4.10
+Version: 0.8.4.11
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

{pyegeria-0.8.4.10.dist-info → pyegeria-0.8.4.11.dist-info}/RECORD

@@ -70,7 +70,7 @@ pyegeria/_validators.py,sha256=DQuMsATRGxGSBtOrVtXlCgWXGhj6Nh-uqPtCsrUGLxk,12703
 pyegeria/action_author_omvs.py,sha256=LbJ8dTHrjy2OHvP1sHCCIRgRU2AD3IV-49kB1UCoQPc,6451
 pyegeria/asset_catalog_omvs.py,sha256=GzTYJjeXh3rY5Ykok0ZcJ3H1bGyQcubI0ZWjFF78iCU,24335
 pyegeria/automated_curation_omvs.py,sha256=DhSrDX_uS0SfmzRRNi1Th0jmdQa9N4S42mIunxrih9s,150418
-pyegeria/classification_manager_omvs.py,sha256=fBwizYyAWsKOlKbZZSc-MQODbh2QeI0Fb9OWFBXTEy8,193022
+pyegeria/classification_manager_omvs.py,sha256=hOKYqNWfAFqwwVgvkUok8kzD4g0pOaNI7QxrkjPZDMI,200796
 pyegeria/collection_manager_omvs.py,sha256=C8cfgGsx6MpG1Nds3JahyqXel8zpb-9iwXsXCAuzmg0,109717
 pyegeria/core_omag_server_config.py,sha256=_GstDYb6XYNCt59l1mMxTR8EoUvwlBi3RK93wKvrcWk,93730
 pyegeria/create_tech_guid_lists.py,sha256=RYRWdXm2bhCMkbUlOdMJ8cKZnamJvSkY5XMK2RjLX4M,4631
@@ -88,12 +88,12 @@ pyegeria/my_profile_omvs.py,sha256=vxi0Dr0qwHV4auqKCjYvWYpF-BAUbLQt58fXGYcqEu4,4
 pyegeria/platform_services.py,sha256=4BfyGdQwGwi2cd9mJdNoUB3LNFNbiyC2_ZQhGtpcxTA,41624
 pyegeria/project_manager_omvs.py,sha256=f8ahjdPxFv90JEE0fc2AV7Kc0hd9jazGQbx5KVe7gQM,74521
 pyegeria/registered_info.py,sha256=WWWxkQJbHnu6KItVpMjOqLerq5thP35qih7rFgW8v9w,6356
-pyegeria/runtime_manager_omvs.py,sha256=OlrJ3xO7-qYZcHS0YKWo57QLt5x_CZ1bOVcrNRlmvMg,35841
+pyegeria/runtime_manager_omvs.py,sha256=ER4oTdbUNFLrO9Gihzd_wcnAIBdlry450NxezMYcl70,39488
 pyegeria/server_operations.py,sha256=ciH890hYT85YQ6OpByn4w7s3a7TtvWZpIG5rkRqbcI0,16766
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
 pyegeria/valid_metadata_omvs.py,sha256=6Hc4g9BOS8w1ILfTG3_A1tfIX3HLtpgZZvcC-z9GePU,36185
-pyegeria-0.8.4.10.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.8.4.10.dist-info/METADATA,sha256=BPTty0no9lQnyZ-mU2HLwnPgymucRhjNpgibX6bFMiI,2820
-pyegeria-0.8.4.10.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-0.8.4.10.dist-info/entry_points.txt,sha256=5Q9bDxIqPgdhd3lDnzdRSCYy9hZtNm_BL49bcmbBpGQ,3808
-pyegeria-0.8.4.10.dist-info/RECORD,,
+pyegeria-0.8.4.11.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.8.4.11.dist-info/METADATA,sha256=JgfmTJbjUQi2aSvJHpQ3NmTSh-eX6Vq0gt76Y2wBs9Y,2820
+pyegeria-0.8.4.11.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-0.8.4.11.dist-info/entry_points.txt,sha256=5Q9bDxIqPgdhd3lDnzdRSCYy9hZtNm_BL49bcmbBpGQ,3808
+pyegeria-0.8.4.11.dist-info/RECORD,,