pyegeria 0.5.5.22__py3-none-any.whl → 0.5.5.24__py3-none-any.whl

examples/widgets/operational/view_asset_events.py

@@ -29,7 +29,7 @@ EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
 EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
 
 
-def main():
+def main(ep: str):
 
     disable_ssl_warnings = True
     console = Console(width=200)
@@ -40,11 +40,11 @@ def main():
 
     # Define the Kafka consumer configuration.
     config = {
-        'bootstrap.servers': EGERIA_KAFKA_ENDPOINT,  # replace with your Kafka broker(s)
+        'bootstrap.servers': ep,  # replace with your Kafka broker(s)
         'group.id': f"view_asset_events:{current_time}",  # replace with your consumer group
         'auto.offset.reset': earliest_latest  # can be set to 'earliest' or 'latest'
     }
-
+    print(f"Kafka config is {json.dumps(config)}")
     # Initialize a Kafka consumer.
     consumer = Consumer(config)
 
@@ -53,7 +53,7 @@ def main():
 
     try:
         while True:
-            msg = consumer.poll(1.0)  # timeout set to 1 second
+            msg = consumer.poll(2.0)  # timeout set to 1 second
 
             if msg is None:
                 continue
@@ -87,4 +87,11 @@ def main():
         consumer.close()
 
 if __name__ == "__main__":
-    main()
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--ep", help="Endpoint to connect to")
+    args = parser.parse_args()
+
+    ep = args.ep if args.ep is not None else EGERIA_KAFKA_ENDPOINT
+
+    main(ep)

pyegeria/automated_curation_omvs.py

@@ -10,13 +10,9 @@ from datetime import datetime
 
 from httpx import Response
 
-from pyegeria import Client, max_paging_size, body_slimmer
+from pyegeria import Client, max_paging_size, body_slimmer, INTEGRATION_GUIDS, TEMPLATE_GUIDS
 from pyegeria._exceptions import (InvalidParameterException, PropertyServerException, UserNotAuthorizedException)
 from ._validators import validate_name, validate_guid, validate_search_string
-from .core_guids import (FILEFOLDER_TEMPLATE_GUID,
-                        POSTGRESQL_SERVER_TEMPLATE_GUID,
-                        APACHE_KAFKA_SERVER_TEMPLATE_GUID,
-                         )
 
 
 class AutomatedCuration(Client):
@@ -169,7 +165,7 @@ class AutomatedCuration(Client):
                 The GUID of the Kafka server element.
         """
 
-        body = {"templateGUID":APACHE_KAFKA_SERVER_TEMPLATE_GUID, "isOwnAnchor": 'true',
+        body = {"templateGUID":TEMPLATE_GUIDS['Apache Kafka Server template'], "isOwnAnchor": 'true',
                 "placeholderPropertyValues": {"serverName": kafka_server, "hostIdentifier": host_name,
                                               "portNumber": port, "description": description}}
         body_s = body_slimmer(body)
@@ -241,7 +237,7 @@ class AutomatedCuration(Client):
             str
                 The GUID of the Postgres server element.
         """
-        body = {"templateGUID":POSTGRESQL_SERVER_TEMPLATE_GUID, "isOwnAnchor": 'true',
+        body = {"templateGUID":TEMPLATE_GUIDS['PostgreSQL Server template'], "isOwnAnchor": 'true',
                 "placeholderPropertyValues": {"serverName": postgres_server, "hostIdentifier": host_name,
                                               "portNumber": port, "databaseUserId": db_user, "description": description,
                                               "databasePassword": db_pwd}}
@@ -319,7 +315,7 @@ class AutomatedCuration(Client):
         str
             The GUID of the File Folder element.
         """
-        body = {"templateGUID": FILEFOLDER_TEMPLATE_GUID,
+        body = {"templateGUID": TEMPLATE_GUIDS['FileFolder template'],
                 "isOwnAnchor": 'true',
                 "placeholderPropertyValues": {
                     "directoryPathName": path_name,
@@ -1429,8 +1425,8 @@ class AutomatedCuration(Client):
             - request source elements for the resulting governance action service
         action_targets: [str]
             -list of action target names to GUIDs for the resulting governance action service
-        start_time: datetime
-            - time to start the process
+        start_time: datetime, default = None
+            - time to start the process, no earlier than start time. None means now.
         request_parameters: [str]
             - parameters passed into the process
         orig_service_name: str
@@ -1465,8 +1461,8 @@ class AutomatedCuration(Client):
         return response.json().get("guid", "Action not initiated")
 
     def initiate_gov_action_type(self, action_type_qualified_name: str, request_source_guids: [str],
-                                 action_targets: list, start_time: datetime, request_parameters: dict,
-                                 orig_service_name: str, orig_engine_name: str, server: str = None) -> str:
+                                 action_targets: list, start_time: datetime = None, request_parameters: dict = None,
+                                 orig_service_name: str = None, orig_engine_name: str = None, server: str = None) -> str:
         """ Using the named governance action type as a template, initiate an engine action.
 
         Parameters
@@ -1477,8 +1473,8 @@ class AutomatedCuration(Client):
             - request source elements for the resulting governance action service
         action_targets: [str]
             -list of action target names to GUIDs for the resulting governance action service
-        start_time: datetime
-            - time to start the process
+        start_time: datetime, default = None
+            - time to start the process, no earlier than start time. None means now.
         request_parameters: [str]
             - parameters passed into the process
         orig_service_name: str
@@ -1513,7 +1509,7 @@ class AutomatedCuration(Client):
 
         body = {"class": "InitiateGovernanceActionTypeRequestBody",
                 "governanceActionTypeQualifiedName":
-                    "Egeria:GovernanceActionType:2adeb8f1-0f59-4970-b6f2-6cc25d4d2402survey-postgres-database",
+                    "AssetSurvey-postgres-database",
                 "actionTargets": [{"class": "NewActionTarget", "actionTargetName": "serverToSurvey",
                                    "actionTargetGUID": postgres_database_guid}]}
         response = await self._async_make_request("POST", url, body)
@@ -1532,7 +1528,7 @@ class AutomatedCuration(Client):
                f"initiate")
 
         body = {"class": "InitiateGovernanceActionTypeRequestBody",
-                "governanceActionTypeQualifiedName": "Egeria:GovernanceActionType:AssetSurvey:survey-postgres-server",
+                "governanceActionTypeQualifiedName": "AssetSurvey:survey-postgres-server",
                 "actionTargets": [{"class": "NewActionTarget", "actionTargetName": "serverToSurvey",
                                    "actionTargetGUID": postgres_server_guid}]}
         response = await self._async_make_request("POST", url, body)
@@ -1575,10 +1571,10 @@ class AutomatedCuration(Client):
             in the Core Content Brain.
 
             File Folder Survey Names currently include::
-            - Egeria:GovernanceActionType:AssetSurvey:survey-folders
-            - Egeria:GovernanceActionType:AssetSurvey:survey-folder-and-files
-            - Egeria:GovernanceActionType:AssetSurvey:survey-all-folders
-            - Egeria:GovernanceActionType:AssetSurvey:survey-all-folders-and-files
+            - AssetSurvey:survey-folders
+            - AssetSurvey:survey-folder-and-files
+            - AssetSurvey:survey-all-folders
+            - AssetSurvey:survey-all-folders-and-files
         """
         server = self.server_name if server is None else server
         url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/governance-action-types/"
@@ -1672,7 +1668,7 @@ class AutomatedCuration(Client):
                f"initiate")
 
         body = {"class": "InitiateGovernanceActionTypeRequestBody",
-                "governanceActionTypeQualifiedName": "Egeria:GovernanceActionType:AssetSurvey:survey-kafka-server",
+                "governanceActionTypeQualifiedName": "AssetSurvey:survey-kafka-server",
                 "actionTargets": [{"class": "NewActionTarget", "actionTargetName": "serverToSurvey",
                                    "actionTargetGUID": kafka_server_guid}]}
         response = await self._async_make_request("POST", url, body)
@@ -1922,8 +1918,11 @@ class AutomatedCuration(Client):
         return response
 
     async def _async_add_catalog_target(self, integ_connector_guid: str, metadata_element_guid: str,
-                                        catalog_target_name: str, metadata_src_qual_name: str = None,
-                                        config_properties: dict = None, server: str = None) -> str:
+                                        catalog_target_name: str, connection_name: str= None,
+                                        metadata_src_qual_name: str = None,
+                                        config_properties: dict = None, template_properties: dict = None,
+                                        permitted_sync: str = "BOTH_DIRECTIONS", delete_method: str = "ARCHIVE",
+                                        server: str = None) -> str:
         """ Add a catalog target to an integration connector and .
             Async version.
 
@@ -1935,12 +1934,21 @@ class AutomatedCuration(Client):
                 The specific metadata element target we want to retrieve.
             catalog_target_name : dict
                 Name of the catalog target to add.
+            connection_name: str, default = None
+                Optional name of connection to use for this catalog target when multiple connections defined.
             metadata_src_qual_name: str
                 The qualified name of the metadata source for the catalog target
             config_properties: dict
                 Configuration properties for the catalog target
+            template_properties: dict
+                Template properties to pass
+            permitted_sync: str, default = BOTH_DIRECTIONS
+                Direction the metadata is allowed to flow (BOTH_DIRECTIONS, FROM_THIRD_PARTH, TO_THIRD_PARTY
+            delete_method: str, default = ARCHIVE
+                Controls the type of delete. Use ARCHIVE for lineage considerations. Alternative is SOFT_DELETE.
             server: str, optional
                 The name of the server. If None, will use the default server specified in the instance will be used.
+
             Returns:
             -------
                 Relationship GUID for the catalog target,
@@ -1959,14 +1967,21 @@ class AutomatedCuration(Client):
         url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/integration-connectors/"
                f"{integ_connector_guid}/catalog-targets/{metadata_element_guid}")
         body = {"catalogTargetName": catalog_target_name, "metadataSourceQualifiedName": metadata_src_qual_name,
-                "configProperties": config_properties}
+                "configProperties": config_properties, "templateProperties": template_properties,
+                "connectionName": connection_name, "permittedSynchronization": permitted_sync,
+                "deleteMethod": delete_method
+                }
+
         response = await self._async_make_request("POST", url, body)
         return response.json().get('guid', "No Guid returned")
 
-    def add_catalog_target(self, integ_connector_guid: str, metadata_element_guid: str, catalog_target_name: str,
-                           metadata_src_qual_name: str = None, config_properties: dict = None,
-                           server: str = None) -> str:
-        """ Add a catalog target to an integration connector.
+    def add_catalog_target(self, integ_connector_guid: str, metadata_element_guid: str,
+                            catalog_target_name: str, connection_name: str= None,
+                            metadata_src_qual_name: str = None,
+                            config_properties: dict = None, template_properties: dict = None,
+                            permitted_sync: str = "BOTH_DIRECTIONS", delete_method: str = "ARCHIVE",
+                            server: str = None) -> str:
+        """ Add a catalog target to an integration connector and .
 
             Parameters:
             ----------
@@ -1976,15 +1991,24 @@ class AutomatedCuration(Client):
                 The specific metadata element target we want to retrieve.
             catalog_target_name : dict
                 Name of the catalog target to add.
+            connection_name: str, default = None
+                Optional name of connection to use for this catalog target when multiple connections defined.
             metadata_src_qual_name: str
                 The qualified name of the metadata source for the catalog target
             config_properties: dict
                 Configuration properties for the catalog target
+            template_properties: dict
+                Template properties to pass
+            permitted_sync: str, default = BOTH_DIRECTIONS
+                Direction the metadata is allowed to flow (BOTH_DIRECTIONS, FROM_THIRD_PARTH, TO_THIRD_PARTY
+            delete_method: str, default = ARCHIVE
+                Controls the type of delete. Use ARCHIVE for lineage considerations. Alternative is SOFT_DELETE.
             server: str, optional
                 The name of the server. If None, will use the default server specified in the instance will be used.
+
             Returns:
             -------
-                None
+                Relationship GUID for the catalog target,
 
             Raises:
             ------
@@ -1996,28 +2020,42 @@ class AutomatedCuration(Client):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_add_catalog_target(integ_connector_guid, metadata_element_guid, catalog_target_name,
-                                           metadata_src_qual_name, config_properties, server))
+                                           connection_name, metadata_src_qual_name, config_properties,
+                                           template_properties, permitted_sync, delete_method,
+                                           server))
         return response
 
     async def _async_update_catalog_target(self, relationship_guid: str,
-                                           catalog_target_name: str, metadata_src_qual_name: str = None,
-                                           config_properties: dict = None, server: str = None) -> None:
+                                           catalog_target_name: str, connection_name: str = None,
+                                           metadata_src_qual_name: str = None,
+                                           config_properties: dict = None, template_properties: dict = None,
+                                           permitted_sync: str = "BOTH_DIRECTIONS", delete_method: str = "ARCHIVE",
+                                           server: str = None
+                                           ) -> None:
         """ Update a catalog target to an integration connector.
             Async version.
 
             Parameters:
             ----------
             relationship_guid: str
-                The GUID (Globally Unique Identifier) of the integration connector used to retrieve catalog targets.
-
+                The GUID (Globally Unique Identifier) of the relationship used to retrieve catalog targets.
             catalog_target_name : dict
                 Name of the catalog target to add.
+            connection_name: str, default = None
+                Optional name of connection to use for this catalog target when multiple connections defined.
             metadata_src_qual_name: str
                 The qualified name of the metadata source for the catalog target
             config_properties: dict
                 Configuration properties for the catalog target
+            template_properties: dict
+                Template properties to pass
+            permitted_sync: str, default = BOTH_DIRECTIONS
+                Direction the metadata is allowed to flow (BOTH_DIRECTIONS, FROM_THIRD_PARTH, TO_THIRD_PARTY
+            delete_method: str, default = ARCHIVE
+                Controls the type of delete. Use ARCHIVE for lineage considerations. Alternative is SOFT_DELETE.
             server: str, optional
                 The name of the server. If None, will use the default server specified in the instance will be used.
+
             Returns:
             -------
                 None
@@ -2035,42 +2073,49 @@ class AutomatedCuration(Client):
         url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/catalog-targets/"
                f"{relationship_guid}/update")
         body = {"catalogTargetName": catalog_target_name, "metadataSourceQualifiedName": metadata_src_qual_name,
-                "configProperties": config_properties}
-        response = await self._async_make_request("POST", url, body)
+                "configProperties": config_properties, "templateProperties": template_properties,
+                "connectionName": connection_name, "permittedSynchronization": permitted_sync,
+                "deleteMethod": delete_method
+                }
+        await self._async_make_request("POST", url, body)
         return
 
-    def update_catalog_target(self, relationship_guid: str, catalog_target_name: str,
-                              metadata_src_qual_name: str = None, config_properties: dict = None,
-                              server: str = None) -> None:
-        """ Add a catalog target to an integration connector.
+    def update_catalog_target(self, relationship_guid: str,
+                           catalog_target_name: str, connection_name: str = None,
+                           metadata_src_qual_name: str = None,
+                           config_properties: dict = None, template_properties: dict = None,
+                           permitted_sync: str = "BOTH_DIRECTIONS", delete_method: str = "ARCHIVE",
+                           server: str = None
+                           ) -> None:
+        """ Update a catalog target to an integration connector.
 
-            Parameters:
-            ----------
-            relationship_guid: str
-                The GUID (Globally Unique Identifier) of the integration connector used to retrieve catalog targets.
-            catalog_target_name : dict
-                Name of the catalog target to add.
-            metadata_src_qual_name: str
-                The qualified name of the metadata source for the catalog target
-            config_properties: dict
-                Configuration properties for the catalog target
-            server: str, optional
-                The name of the server. If None, will use the default server specified in the instance will be used.
-            Returns:
-            -------
-                None
+        Parameters:
+        ----------
+        relationship_guid: str
+            The GUID (Globally Unique Identifier) of the relationship used to retrieve catalog targets.
+        catalog_target_name : dict
+            Name of the catalog target to add.
+        connection_name: str, default = None
+            Optional name of connection to use for this catalog target when multiple connections defined.
+        metadata_src_qual_name: str
+            The qualified name of the metadata source for the catalog target
+        config_properties: dict
+            Configuration properties for the catalog target
+        template_properties: dict
+            Template properties to pass
+        permitted_sync: str, default = BOTH_DIRECTIONS
+            Direction the metadata is allowed to flow (BOTH_DIRECTIONS, FROM_THIRD_PARTH, TO_THIRD_PARTY
+        delete_method: str, default = ARCHIVE
+            Controls the type of delete. Use ARCHIVE for lineage considerations. Alternative is SOFT_DELETE.
+        server: str, optional
+    """
 
-            Raises:
-            ------
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-                                       this exception is raised with details from the response content.
-            PropertyServerException: If the API response indicates a server side error.
-            UserNotAuthorizedException:
-            """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
             self._async_update_catalog_target(relationship_guid, catalog_target_name,
-                                              metadata_src_qual_name, config_properties, server))
+                                              connection_name,metadata_src_qual_name,
+                                              config_properties, template_properties,permitted_sync,
+                                              delete_method,server))
         return
 
     async def _async_remove_catalog_target(self, relationship_guid: str, server: str = None) -> None:

{pyegeria-0.5.5.22.dist-info → pyegeria-0.5.5.24.dist-info}/METADATA

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

{pyegeria-0.5.5.22.dist-info → pyegeria-0.5.5.24.dist-info}/RECORD

@@ -21,7 +21,7 @@ examples/widgets/operational/__init__.py,sha256=8ebdyTD7i-XXyZr0vDx6jnXalE6QjhCv
 examples/widgets/operational/get_tech_type_elements.py,sha256=_wSZOShJ17kuMlgh8xC-iAzByi1A0JeB4cmEiAL87M0,5846
 examples/widgets/operational/get_tech_type_template.py,sha256=qIb-JYcoI_YR7NHUKH7TSdq56QI1H4QuyqWTvldNKNo,5866
 examples/widgets/operational/refresh_integration_daemon.py,sha256=7GF_xzO83nhvTaxJR2DMI7fsHg6TA4xaIy7z8YNbSlk,2274
-examples/widgets/operational/view_asset_events.py,sha256=yQa8Z19x6ipdR1QHCta1D-yih90pQ_TW2L6l_ekr2tA,3419
+examples/widgets/operational/view_asset_events.py,sha256=XagfKloRfoeKO8-YOGBWJ4IPFdlUOB35tFmWJSDAbpg,3662
 examples/widgets/operational/view_coco_status.py,sha256=QloMgVcXL2Fx2XHyk71PKCwmzRfc_Q_cAvpyomcYi_Y,3322
 examples/widgets/operational/view_eng_action_status.py,sha256=Qj3ySRG58rsYFyFzgyxsHUMLclSMG3Qn3WQG2ERknMs,6108
 examples/widgets/operational/view_gov_eng_status.py,sha256=6HI_cp_cOPptWYQ5WMoDdWctwwfzTqYLmJMOoIGb6ec,4543
@@ -46,7 +46,7 @@ pyegeria/_globals.py,sha256=DF6851qHPpoDrY4w5JGmT-8zmMfVXf9MMG6nKlu-BYM,616
 pyegeria/_validators.py,sha256=DQuMsATRGxGSBtOrVtXlCgWXGhj6Nh-uqPtCsrUGLxk,12703
 pyegeria/action_author_omvs.py,sha256=m0wsfmyO-VxRDaPpACeIDw8eVAFu3RVbo45RPCUel9M,6340
 pyegeria/asset_catalog_omvs.py,sha256=Y-Eh0k-zkJNOChVlLbC2bsTSBVLWhk-0-ewCV4YlyDY,25802
-pyegeria/automated_curation_omvs.py,sha256=yp5d7D_nNRrx92MU8Z72zw5nloTzBDJVfxvwZrvlVWk,118212
+pyegeria/automated_curation_omvs.py,sha256=7DV5SKkP9zPmHVPSVY9X8NdLIBJO9E6jx2XrwW4CjsI,121428
 pyegeria/collection_manager_omvs.py,sha256=IyGCbqx2Blm0OwCsC2071EeoNWHXyWGl_6pEtacizAs,112642
 pyegeria/core_guids.py,sha256=JKziCsKhklbWRramQ0orRMNTudJXYB721a32TJegBl4,4320
 pyegeria/core_omag_server_config.py,sha256=16ld7aBTgO3gGhvFs-_yzwqPsatdCAiKYi005_2evZU,93096
@@ -63,8 +63,8 @@ pyegeria/server_operations.py,sha256=hEaU6YC0iNEQFvcXYvcE4J6BQKlqMJk33nViCNIEBE4
 pyegeria/tech_guids_22-07-2024 13:22.py,sha256=nsjPrCDf9gohdw3LRcO5-uwzBN_nMB7Re_vtDJIgaIY,4643
 pyegeria/utils.py,sha256=f8isUaKDy-GJxhwswWgP_bw6q1CUzBUNVcCtin8N1cA,5433
 pyegeria/valid_metadata_omvs.py,sha256=aisdRodIwJSkyArAzfm_sEnBELh69xE8k4Nea-vHu8M,36745
-pyegeria-0.5.5.22.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.5.5.22.dist-info/METADATA,sha256=WWZiHAWAWxf6heVJfraaR0Fl_JUqiFcbJB-gKEDFIgg,2612
-pyegeria-0.5.5.22.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-0.5.5.22.dist-info/entry_points.txt,sha256=WgNY6OkZlWQ5uwE_qtyfVyuOX-dnOKyH0cW2JlKRIJ0,2038
-pyegeria-0.5.5.22.dist-info/RECORD,,
+pyegeria-0.5.5.24.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.5.5.24.dist-info/METADATA,sha256=k3qekA4g_-NusyS_KUplGR47l-O2yky_aoTRSDkdaRc,2612
+pyegeria-0.5.5.24.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-0.5.5.24.dist-info/entry_points.txt,sha256=WgNY6OkZlWQ5uwE_qtyfVyuOX-dnOKyH0cW2JlKRIJ0,2038
+pyegeria-0.5.5.24.dist-info/RECORD,,