pyegeria 0.3.9__py3-none-any.whl → 0.4.0__py3-none-any.whl

pyegeria/core_guids.py

@@ -0,0 +1,128 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Useful from core content archive
+"""
+
+#
+# Template guids
+#
+
+FILE_FOLDER_TEMPLATE = "553f51cf-3981-480e-acd8-86ed3e25329d"
+
+KAFKA_SERVER_TEMPLATE = "5e1ff810-5418-43f7-b7c4-e6e062f9aff7"
+
+POSTGRESQL_SERVER_TEMPLATE = "542134e6-b9ce-4dce-8aef-22e8daf34fdb"
+
+CSV_Data_File_template_GUID = '1b81010e-8525-43b4-8bd9-40c102f7f7d6'
+
+Keystore_File_template_GUID = '754def0b-b811-4ea0-b8bf-7414fa8a77b4'
+
+OSS_Unity_Catalog_Function_template_GUID = '4ae9f6df-4678-4b0a-a492-4a982c8397fd'
+
+Data_File_template_GUID = 'd7633260-0810-43fe-ba48-f3e3e3e7c95c'
+
+View_Server_template_GUID = 'fd61ca01-390d-4aa2-a55d-426826aa4e1b'
+
+Archive_File_template_GUID = '8a4ea587-dd3e-4148-8c01-0d366d19de11'
+
+PostgreSQL_Relational_Database_template_GUID = '3d398b3f-7ae6-4713-952a-409f3dea8520'
+
+OSS_Unity_Catalog_Volume_template_GUID = 'bf4dc272-a323-4ca7-8e37-b78a005ac578'
+
+Program_File_template_GUID = 'd8b8cae5-f4bd-4631-8836-88dc67a55c00'
+
+FileFolder_template_GUID = '99b0c995-7494-4063-89d1-1e0ec7153abd'
+
+OSS_Unity_Catalog_Catalog_template_GUID = '8bf8f102-490f-4718-bd27-d018660124b6'
+
+PostgreSQL_Server_template_GUID = '542134e6-b9ce-4dce-8aef-22e8daf34fdb'
+
+Audio_Data_File_template_GUID = 'f65ea229-5473-469f-a447-32ba09bf1f14'
+
+Document_File_template_GUID = '080ca599-095a-499e-ba26-7d58e538c32a'
+
+Integration_Daemon_template_GUID = '6b3516f0-dd13-4786-9601-07215f995197'
+
+XML_Data_File_template_GUID = '643a284b-3137-41de-8c37-521dcd3a1441'
+
+Parquet_Data_File_template_GUID = '2396c38e-54aa-4d04-a95d-ce02fb998c55'
+
+ThreeD_Image_Data_File_template_GUID = '5648eaa6-4826-4964-9657-78ab9cc387d8'
+
+YAML_File_template_GUID = '6515915a-c218-4e55-9b2c-d5fbec9dfdb4'
+
+Metadata_Access_Server_template_GUID = 'bd8de890-fa79-4c24-aab8-20b41b5893dd'
+
+Properties_File_template_GUID = '1cefcfe3-585d-4d78-a4dd-3f929f5c5a9b'
+
+Vector_Data_File_template_GUID = 'ea60c096-71e6-4492-ba10-90de63e4fe3a'
+
+Apache_Kafka_Server_template_GUID = '5e1ff810-5418-43f7-b7c4-e6e062f9aff7'
+
+OSS_Unity_Catalog_Schema_template_GUID = 'd95e5364-4ebf-42d5-bb39-ff1334143b15'
+
+Executable_File_template_GUID = '588c89e7-cc16-4ae1-8b81-0cd90250df0c'
+
+JSON_Data_File_template_GUID = 'c62ff28b-5cd2-4c74-bba3-0a875ddbbdf4'
+
+File_System_template_GUID = 'd3b548d5-c5bf-42f7-8714-80a034b00424'
+
+Source_Code_File_template_GUID = '092e6742-7d5a-40cb-b5be-b0440e730c0a'
+
+OSS_Unity_Catalog_Server_template_GUID = '1077a346-7a50-4cb0-a795-b219bafaabf6'
+
+Apple_MacBook_Pro_template_GUID = '32a9fd56-85c9-47fe-a211-9da3871bf4da'
+
+Build_Instruction_File_template_GUID = '7a2b22a1-2198-4ad6-adc0-8a3c2e2faaa7'
+
+Spreadsheet_Data_File_template_GUID = '33860da2-c467-4192-908c-f8dab837c098'
+
+UNIX_File_System_template_GUID = '6d82998d-5d6c-4cd2-902e-8baa98e152d4'
+
+Video_Data_File_template_GUID = '6d7b46f9-c7ea-4d68-b66b-b077ec91bc19'
+
+PostgreSQL_Relational_Database_Schema_template_GUID = '82a5417c-d882-4271-8444-4c6a996a8bfc'
+
+Engine_Host_template_GUID = '1764a891-4234-45f1-8cc3-536af40c790d'
+
+Avro_Data_File_template_GUID = '0c61cfef-a0d3-4130-85fc-d5c39287499c'
+
+OSS_Unity_Catalog_Table_template_GUID = 'f5b12348-92ac-4a52-b8e0-b06cf215484e'
+
+File_template_GUID = '9725e90e-ebad-474f-af65-a8aaaca03208'
+
+Apache_Kafka_Topic_template_GUID = 'ea8f81c9-c59c-47de-9525-7cc59d1251e5'
+
+Script_File_template_GUID = '4842a347-56a1-4940-b340-2f39cf91dc6d'
+
+Apache_Atlas_Server_template_GUID = 'fe6dce45-a978-4417-ab55-17f05b8bcea7'
+
+Raster_Data_File_template_GUID = 'c972afee-0170-446f-893b-f88a373a4a99'
+
+Data_Folder_template_GUID = 'e854455c-8b5a-4030-8289-2323f7f68841'
+
+OMAG_Server_Platform_template_GUID = '9b06c4dc-ddc8-47ae-b56b-28775d3a96f0'
+
+DBC_Relational_Database_Integration_Connector_GUID = '70dcd0b7-9f06-48ad-ad44-ae4d7a7762aa'
+
+#
+# Integration Connector GUIDS
+#
+
+PostgreSQL_Relational_Database_Integration_Connector_GUID = '70dcd0b7-9f06-48ad-ad44-ae4d7a7762aa'
+
+Landing_Area_File_Monitor_Integration_Connector_GUID = '1b98cdac-dd0a-4621-93db-99ef5a1098bc'
+
+FileFolder_Integration_Connector_GUID = 'cd6479e1-2fe7-4426-b358-8a0cf70be117'
+
+OSS_Unity_Catalog_Catalog_Integration_Connector_GUID = '74dde22f-2249-4ea3-af2b-b39e73f79b81'
+
+PostgreSQL_Server_Integration_Connector_GUID = '36f69fd0-54ba-4f59-8a44-11ccf2687a34'
+
+Apache_Kafka_Server_Integration_Connector_GUID = 'fa1f711c-0b34-4b57-8e6e-16162b132b0c'
+
+Software_Server_Integration_Connector_GUID = 'b89d9a5a-2ea6-49bc-a4fc-e7df9f3ca93e'
+
+OSS_Unity_Catalog_Server_Integration_Connector_GUID = '06d068d9-9e08-4e67-8c59-073bbf1013af'

pyegeria/{Xglossary_manager_omvs.py → glossary_manager_omvs.py}

@@ -2,7 +2,7 @@
 PDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-This module contains an initial version of the glossary_workflow omvs module. There are additional methods that will be
+This module contains an initial version of the glossary_manager omvs module. There are additional methods that will be
 added in subsequent versions of the glossary_omvs module.
 
 """
@@ -13,8 +13,9 @@ from datetime import datetime, time
 from pyegeria._client import Client
 from pyegeria._globals import enable_ssl_check
 from pyegeria._validators import (validate_name, validate_guid, validate_search_string, )
-from pyegeria.utils import body_slimmer
 from pyegeria.glossary_browser_omvs import GlossaryBrowser
+from pyegeria.utils import body_slimmer
+
 
 class GlossaryManager(GlossaryBrowser):
     """
@@ -39,7 +40,7 @@ class GlossaryManager(GlossaryBrowser):
      """
 
     def __init__(self, server_name: str, platform_url: str, token: str = None, user_id: str = None,
-            user_pwd: str = None, verify_flag: bool = enable_ssl_check, sync_mode: bool = True):
+                 user_pwd: str = None, verify_flag: bool = enable_ssl_check, sync_mode: bool = True):
         self.admin_command_root: str
         Client.__init__(self, server_name, platform_url, user_id=user_id, token=token, async_mode=sync_mode)
 
@@ -68,10 +69,10 @@ class GlossaryManager(GlossaryBrowser):
         if server_name is None:
             server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-workflow/glossaries/"
+        url = f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-manager/glossaries/"
         body = {
-                "class" : "ReferenceableRequestBody",
-                "elementProperties":
+            "class": "ReferenceableRequestBody",
+            "elementProperties":
                 {
                     "class": "GlossaryProperties",
                     "qualifiedName": f"Glossary-{display_name}-{time.asctime()}",
@@ -122,13 +123,13 @@ class GlossaryManager(GlossaryBrowser):
         if server_name is None:
             server_name = self.server_name
 
-        url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-workflow/glossaries/"
-              f"{glossary_guid}/remove")
+        url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-manager/glossaries/"
+               f"{glossary_guid}/remove")
 
         await self._async_make_request("POST", url)
         return
 
-    def delete_glossary(self, glossary_guid: str,  server_name: str = None) -> None:
+    def delete_glossary(self, glossary_guid: str, server_name: str = None) -> None:
         """ Create a new glossary.
 
         Parameters
@@ -220,7 +221,7 @@ class GlossaryManager(GlossaryBrowser):
             search_string = None
 
         body = {"class": "SearchStringRequestBody", "searchString": search_string, "effectiveTime": effective_time,
-            "typeName": type_name}
+                "typeName": type_name}
         body = body_slimmer(body)
         # print(f"\n\nBody is: \n{body}")
 
@@ -331,7 +332,7 @@ class GlossaryManager(GlossaryBrowser):
                f"{glossary_guid}/retrieve")
         print(url)
         response = await self._async_make_request("POST", url, payload=body)
-        return response
+        return response.json()
 
     def get_glossary_by_guid(self, glossary_guid: str, server_name: str = None) -> dict:
         """ Retrieves information about a glossary
@@ -514,7 +515,7 @@ class GlossaryManager(GlossaryBrowser):
         return response.json().get("guid", None)
 
     def create_category(self, glossary_guid: str, display_name: str, description: str,
-                                     server_name: str = None) -> str:
+                        server_name: str = None) -> str:
         """ Create a new category within the specified glossary.
 
         Parameters
@@ -551,8 +552,6 @@ class GlossaryManager(GlossaryBrowser):
             self._async_create_category(glossary_guid, display_name, description, server_name))
         return response
 
-
-
     async def _async_get_glossary_for_category(self, glossary_category_guid: str, effective_time: str = None,
                                                server_name: str = None) -> dict | str:
         """ Retrieve the glossary metadata element for the requested category.  The optional request body allows you to
@@ -977,7 +976,7 @@ class GlossaryManager(GlossaryBrowser):
                f"by-name?startFrom={start_from}&pageSize={page_size}")
 
         body = {"class": "GlossaryNameRequestBody", "name": name, "glossaryGUID": glossary_guid,
-            "limitResultsByStatus": status}
+                "limitResultsByStatus": status}
 
         response = await self._async_make_request("POST", url)
         return response.json().get("elementList", "No Categories found")
@@ -1201,7 +1200,8 @@ class GlossaryManager(GlossaryBrowser):
     #
     #  Terms
     #
-    async def _async_create_controlled_glossary_term(self, glossary_guid: str, body: dict, server_name: str = None) -> str:
+    async def _async_create_controlled_glossary_term(self, glossary_guid: str, body: dict,
+                                                     server_name: str = None) -> str:
         """ Create a term for a controlled glossary.
             See also: https://egeria-project.org/types/3/0385-Controlled-Glossary-Development/?h=controlled
             The request body also supports the specification of an effective time for the query.
@@ -1332,7 +1332,7 @@ class GlossaryManager(GlossaryBrowser):
 
         return response
 
-    async def _async_create_term_copy(self, glossary_guid: str, glossary_term_guid: str, new_display_name:str,
+    async def _async_create_term_copy(self, glossary_guid: str, glossary_term_guid: str, new_display_name: str,
                                       version_id: str, term_status: str = "PROPOSED", server_name: str = None) -> str:
         """ Create a new term from an existing term.
 
@@ -1382,23 +1382,23 @@ class GlossaryManager(GlossaryBrowser):
                )
 
         body = {
-                "class" : "GlossaryTemplateRequestBody",
-                "elementProperties" :
-                    {
-                        "class" : "TemplateProperties",
-                        "qualifiedName" : f"Term-{new_display_name}-{time.asctime()}",
-                        "displayName" : new_display_name,
-                        "versionIdentifier" : version_id
-                    },
-                "glossaryTermStatus" : term_status
-            }
+            "class": "GlossaryTemplateRequestBody",
+            "elementProperties":
+                {
+                    "class": "TemplateProperties",
+                    "qualifiedName": f"Term-{new_display_name}-{time.asctime()}",
+                    "displayName": new_display_name,
+                    "versionIdentifier": version_id
+                },
+            "glossaryTermStatus": term_status
+        }
 
         response = await self._async_make_request("POST", url, body)
 
         return response.json().get("guid", "Term not created")
 
-    def create_term_copy(self, glossary_guid: str, glossary_term_guid: str, new_display_name:str,
-                                      version_id: str, term_status: str = "PROPOSED", server_name: str = None) -> str:
+    def create_term_copy(self, glossary_guid: str, glossary_term_guid: str, new_display_name: str,
+                         version_id: str, term_status: str = "PROPOSED", server_name: str = None) -> str:
         """ Create a new term from an existing term.
 
         Parameters
@@ -1437,7 +1437,7 @@ class GlossaryManager(GlossaryBrowser):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_create_term_copy(glossary_guid, glossary_term_guid, new_display_name,
-                                         version_id, term_status,server_name))
+                                         version_id, term_status, server_name))
 
         return response
 
@@ -1542,7 +1542,7 @@ class GlossaryManager(GlossaryBrowser):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_add_data_field_to_term( glossary_term_guid, body,server_name))
+            self._async_add_data_field_to_term(glossary_term_guid, body, server_name))
 
         return
 
@@ -1590,19 +1590,19 @@ class GlossaryManager(GlossaryBrowser):
                )
 
         body = {
-                    "class" : "ClassificationRequestBody",
-                    "properties" :
-                        {
-                            "class" : "GovernanceClassificationProperties",
-                            "levelIdentifier" : confidentiality_level
-                        }
+            "class": "ClassificationRequestBody",
+            "properties":
+                {
+                    "class": "GovernanceClassificationProperties",
+                    "levelIdentifier": confidentiality_level
                 }
+        }
 
         await self._async_make_request("POST", url, body)
         return
 
     def add_confidentiality_to_term(self, glossary_term_guid: str,
-                                                 confidentiality_level: int, server_name: str = None) -> str:
+                                    confidentiality_level: int, server_name: str = None) -> str:
         """ Add the confidentiality classification to a glossary term
 
         Parameters
@@ -1635,12 +1635,13 @@ class GlossaryManager(GlossaryBrowser):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_add_confidentiality_to_term( glossary_term_guid, confidentiality_level,
-                                          server_name))
+            self._async_add_confidentiality_to_term(glossary_term_guid, confidentiality_level,
+                                                    server_name))
 
         return
 
-    async def _async_add_subject_area_to_term(self, glossary_term_guid: str, subject_area: str, server_name: str = None) -> None:
+    async def _async_add_subject_area_to_term(self, glossary_term_guid: str, subject_area: str,
+                                              server_name: str = None) -> None:
         """ Add the confidentiality classification to a glossary term
 
             Async Version.
@@ -1727,13 +1728,13 @@ class GlossaryManager(GlossaryBrowser):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_add_subject_area_to_term( glossary_term_guid, subject_area,
-                                                    server_name))
+            self._async_add_subject_area_to_term(glossary_term_guid, subject_area,
+                                                 server_name))
 
         return
 
     async def _async_update_term(self, glossary_term_guid: str, body: dict, is_merge_update: bool,
-                                            server_name: str = None) -> None:
+                                 server_name: str = None) -> None:
         """ Add the data field values classification to a glossary term
 
             Async Version.
@@ -1783,15 +1784,16 @@ class GlossaryManager(GlossaryBrowser):
         validate_guid(glossary_term_guid)
         is_merge_update_s = str(is_merge_update).lower()
 
-        url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/terms/{glossary_term_guid}/"
-               f"update?isMergeUpdate={is_merge_update_s}"
-               )
+        url = (
+            f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/terms/{glossary_term_guid}/"
+            f"update?isMergeUpdate={is_merge_update_s}"
+            )
 
         await self._async_make_request("POST", url, body)
         return
 
     def update_term(self, glossary_term_guid: str, body: dict, is_merge_update: bool,
-                                            server_name: str = None) -> None:
+                    server_name: str = None) -> None:
         """ Add the data field values classification to a glossary term
 
             Async Version.
@@ -1837,7 +1839,7 @@ class GlossaryManager(GlossaryBrowser):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_update_term( glossary_term_guid, body,is_merge_update,server_name))
+            self._async_update_term(glossary_term_guid, body, is_merge_update, server_name))
 
         return
 
@@ -1879,23 +1881,24 @@ class GlossaryManager(GlossaryBrowser):
             server_name = self.server_name
         validate_guid(glossary_term_guid)
 
-        url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/terms/{glossary_term_guid}/"
-               f"update?isMergeUpdate=true"
-               )
+        url = (
+            f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/terms/{glossary_term_guid}/"
+            f"update?isMergeUpdate=true"
+            )
 
         body = {
-                "class" : "ReferenceableRequestBody",
-                "elementProperties" :
-                    {
-                        "class" : "GlossaryTermProperties",
-                        "publishVersionIdentifier" : new_version_identifier
-                    }
-              }
+            "class": "ReferenceableRequestBody",
+            "elementProperties":
+                {
+                    "class": "GlossaryTermProperties",
+                    "publishVersionIdentifier": new_version_identifier
+                }
+        }
         await self._async_make_request("POST", url, body)
         return
 
     def update_term_version_id(self, glossary_term_guid: str, new_version_identifier: str,
-                                            server_name: str = None) -> None:
+                               server_name: str = None) -> None:
         """ Update a glossary term's version identifier
 
             Async Version.
@@ -1929,12 +1932,10 @@ class GlossaryManager(GlossaryBrowser):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_update_term_version_id( glossary_term_guid, new_version_identifier,server_name))
+            self._async_update_term_version_id(glossary_term_guid, new_version_identifier, server_name))
 
         return
 
-
-
     async def _async_get_terms_for_category(self, glossary_category_guid: str, server_name: str = None,
                                             effective_time: str = None, start_from: int = 0,
                                             page_size: int = None) -> list | str:
@@ -1993,7 +1994,7 @@ class GlossaryManager(GlossaryBrowser):
         return response.json().get("elementList", "No terms found")
 
     def get_terms_for_category(self, glossary_category_guid: str, server_name: str = None,
-                               effective_time:str = None, start_from: int = 0,
+                               effective_time: str = None, start_from: int = 0,
                                page_size: int = None) -> list | str:
         """ Retrieve ALL the glossary terms in a category.
             The request body also supports the specification of an effective time for the query.
@@ -2359,7 +2360,7 @@ class GlossaryManager(GlossaryBrowser):
         for_duplicate_processing_s = str(for_duplicate_processing).lower()
 
         body = {"class": "GlossaryNameRequestBody", "glossaryGUID": glossary_guid, "name": term,
-            "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
+                "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
         # body = body_slimmer(body)
 
         url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
@@ -2803,7 +2804,7 @@ class GlossaryManager(GlossaryBrowser):
         # validate_search_string(search_string)
 
         body = {"class": "GlossarySearchStringRequestBody", "glossaryGUID": glossary_guid,
-            "searchString": search_string, "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
+                "searchString": search_string, "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
         # body = body_slimmer(body)
 
         url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"
@@ -2927,7 +2928,7 @@ class GlossaryManager(GlossaryBrowser):
         for_duplicate_processing_s = str(for_duplicate_processing).lower()
 
         body = {"class": "CommentRequestBody", "commentType": comment_type, "commentText": comment_text,
-            "isPublic": is_public}
+                "isPublic": is_public}
 
         url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/comments/"
                f"{commentGUID}/replies?isPublic={is_public_s}&forLineage={for_lineage_s}&"
@@ -2953,7 +2954,7 @@ class GlossaryManager(GlossaryBrowser):
         for_duplicate_processing_s = str(for_duplicate_processing).lower()
 
         body = {"class": "CommentRequestBody", "commentType": comment_type, "commentText": comment_text,
-            "isPublic": is_public}
+                "isPublic": is_public}
 
         url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/comments/"
                f"{commentGUID}/replies?isPublic={is_public_s}&forLineage={for_lineage_s}&"
@@ -2987,7 +2988,7 @@ class GlossaryManager(GlossaryBrowser):
         # validate_search_string(search_string)
 
         body = {"class": "GlossarySearchStringRequestBody", "glossaryGUID": glossary_guid,
-            "searchString": search_string, "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
+                "searchString": search_string, "effectiveTime": effective_time, "limitResultsByStatus": status_filter}
         # body = body_slimmer(body)
 
         url = (f"{self.platform_url}/servers/{server_name}/api/open-metadata/glossary-browser/glossaries/"