pyegeria 0.6.7__py3-none-any.whl → 0.6.8__py3-none-any.whl

examples/widgets/cat/get_project_structure.py

@@ -3,25 +3,22 @@
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-A simple viewer for collections - provide the root and we display the hierarchy
+A simple viewer for project structure - provide the root and we display the hierarchy
 
 """
 
 import argparse
 import os
+
 from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
 from rich.panel import Panel
 from rich.prompt import Prompt
-from rich.text import Text
 from rich.tree import Tree
-from rich.markdown import Markdown
-from rich.console import Console
 
-from pyegeria import (ProjectManager, MyProfile, UserNotAuthorizedException, PropertyServerException,
-                      InvalidParameterException)
-from pyegeria._exceptions import (
-    print_exception_response,
-)
+from pyegeria import (ProjectManager, UserNotAuthorizedException, PropertyServerException, InvalidParameterException)
+from pyegeria._exceptions import (print_exception_response, )
 
 disable_ssl_warnings = True
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -37,10 +34,13 @@ EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
 EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
 EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
 
+
 def project_structure_viewer(root: str, server_name: str, platform_url: str, user: str, user_password: str,
-                      jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH):
+                             jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH, timeout: int = 30):
     """ A simple collection viewer"""
-    def walk_project_hierarchy(project_client: ProjectManager, project_name: str, tree: Tree, root:bool = False) -> None:
+
+    def walk_project_hierarchy(project_client: ProjectManager, project_name: str, tree: Tree,
+                               root: bool = False) -> None:
         """Recursively build a Tree with collection contents."""
         t = None
         style = "bright_white on black"
@@ -50,12 +50,12 @@ def project_structure_viewer(root: str, server_name: str, platform_url: str, use
             proj_guid = project[0]['elementHeader']['guid']
             proj_props = project[0]['properties']
 
-            proj_type = proj_props.get('typeName','---')
+            proj_type = proj_props.get('typeName', '---')
             proj_unique = proj_props.get('qualifiedName', '---')
             proj_identifier = proj_props.get('identifier', '---')
-            proj_name = proj_props.get('name','---')
-            proj_desc = proj_props.get('description','---')
-            proj_status = proj_props.get('projectStatus','---')
+            proj_name = proj_props.get('name', '---')
+            proj_desc = proj_props.get('description', '---')
+            proj_status = proj_props.get('projectStatus', '---')
             proj_priority = proj_props.get('priority', '---')
             proj_start = proj_props.get('startDate', '---')[:-10]
             proj_props_md = (f"* Name: {proj_name}\n"
@@ -79,66 +79,31 @@ def project_structure_viewer(root: str, server_name: str, platform_url: str, use
             proj_props_md += f"\n### Team Members\n {member_md}"
 
         proj_props_out = Markdown(proj_props_md)
-        p = Panel(proj_props_out, style = style, title=project_name)
+        p = Panel(proj_props_out, style=style, title=project_name)
         t = tree.add(p)
 
-
         linked_projects = project_client.get_linked_projects(proj_guid)
         if type(linked_projects) is list:
             for proj in linked_projects:
                 child_md = ""
                 child_guid = proj['elementHeader']['guid']
                 child_name = proj['properties']['name']
-                # child_props = proj['properties']
-                # for key in child_props.keys():
-                #     child_md += f"* {key}: {child_props[key]}\n"
-                # child_md += f"* GUID: {child_guid}"
                 walk_project_hierarchy(project_client, child_name, t)
 
         else:
             return t
-        #     tt= tree.add(f"[bold magenta on black]No projects match {root_project_name}")
-
-            #
-            # branch = tt.add(f"[bold magenta on black]Members", style=style, guide_style=style)
-            # walk_collection_hierarchy(collection_client, member['qualifiedName'], branch),
-
-        # members = project_client.get_member_list(root_project_name)
-        # if members:
-        #     for member in members:
-        #         style = "bold white on black"
-        #         text_collection_name = Text(f"[bold white on black]Name: {member['name']}", style=style)
-        #         text_qualified_name = Text(f"* QualifiedName: {member['qualifiedName']}")
-        #         text_guid = Text(f"* GUID: {member['guid']}", "green")
-        #         text_collection_type = Text(f"* Collection Type: {member['collectionType']}")
-        #         text_description = Text(f"* Description: {member['description']}")
-        #         p = Panel.fit(f"{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
-        #                       f"{text_collection_type}\n{text_description}")
-        #         tt = tree.add(p, style=style)
-        #
-        #
-        #         linked_projects = project_client.get_linked_projects()
-        #         if type(children) is list:
-        #             branch = tt.add(f"[bold magenta on black]Members", style=style, guide_style=style)
-        #             walk_collection_hierarchy(collection_client, member['qualifiedName'], branch),
-        # else:
-        #     tt = tree.add(f"[bold magenta on black]No collections match {root_collection_name}")
+
     try:
-        console = Console(width=EGERIA_WIDTH)
-        tree = Tree(f"[bold bright green on black]{root}",guide_style="bold bright_blue")
-        p_client = ProjectManager(server_name, platform_url,
-                                     user_id=user)
+        console = Console(width=width, force_terminal=not jupyter)
+        tree = Tree(f"[bold bright green on black]{root}", guide_style="bold bright_blue")
+        p_client = ProjectManager(server_name, platform_url, user_id=user)
 
-        token1= p_client.create_egeria_bearer_token(user, user_password)
+        token1 = p_client.create_egeria_bearer_token(user, user_password)
 
-        walk_project_hierarchy(p_client,root, tree, root = True)
+        walk_project_hierarchy(p_client, root, tree, root=True)
         print(tree)
 
-    except (
-        InvalidParameterException,
-        PropertyServerException,
-        UserNotAuthorizedException
-    ) as e:
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
         print_exception_response(e)
 
 
@@ -161,5 +126,7 @@ def main():
         project_structure_viewer(root_project, server, url, userid, user_pass)
     except (KeyboardInterrupt):
         pass
+
+
 if __name__ == "__main__":
-    main()
+    main()

examples/widgets/cat/list_cert_types.py

@@ -50,7 +50,7 @@ def display_certifications(search_string: str, server: str, url: str, username:
     console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
     if (search_string is None) or ((len(search_string) < 3)) and (search_string != '*'):
         raise ValueError("Invalid Search String - must be greater than four characters long")
-    g_client = ClassificationManager(server, url, user_id=username,user_pwd=user_password )
+    g_client = ClassificationManager(server, url, user_id=username,user_pwd=user_password)
     token = g_client.create_egeria_bearer_token(username, user_password)
 
 

examples/widgets/cli/egeria.py

@@ -12,6 +12,8 @@ This is an emerging capability based on the **click** package. Feedback welcome!
 import click
 from trogon import tui
 
+from examples.widgets.cat.get_project_structure import project_structure_viewer
+from examples.widgets.cat.list_cert_types import display_certifications
 from examples.widgets.cat.get_asset_graph import asset_viewer
 from examples.widgets.cat.get_collection import collection_viewer
 from examples.widgets.cat.get_tech_type_elements import tech_viewer
@@ -22,6 +24,7 @@ from examples.widgets.cat.list_projects import display_project_list
 from examples.widgets.cat.list_tech_types import display_tech_types
 from examples.widgets.cat.list_todos import display_to_dos
 from examples.widgets.cli.ops_config import Config
+
 from examples.widgets.ops.engine_actions import start_server as start_engine_host, \
     stop_server as stop_engine_host
 from examples.widgets.ops.integration_daemon_actions import (add_catalog_target, remove_catalog_target,
@@ -361,6 +364,29 @@ def show_tech_type_templates(ctx, tech_type):
     template_viewer(tech_type, c.view_server, c.view_server_url, c.userid,
                     c.password, c.jupyter, c.width)
 
+@show.command('certification-types')
+@click.option('--search-string', default = 'CertificationType', help="")
+@click.pass_context
+def show_certification_types(ctx, search_string):
+    """Show certification types
+        - generally stay with the default..
+    """
+    c = ctx.obj
+    display_certifications(search_string, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.timeout, c.jupyter, c.width)
+
+@show.command('project-structure')
+@click.option('--project', default = 'Clinical Trials Management',
+              help="Enter the root project to start from")
+@click.pass_context
+def show_project_structure(ctx, project):
+    """Show the structure of the project starting from a root project"""
+    c = ctx.obj
+    project_structure_viewer(project, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.jupyter, c.width, c.timeout)
+
+
+
 
 @show.command('assets')
 @click.argument('search-string')

examples/widgets/cli/egeria_cat.py

@@ -21,6 +21,8 @@ from examples.widgets.cat.list_glossary import display_glossary_terms
 from examples.widgets.cat.list_tech_types import display_tech_types
 from examples.widgets.cat.list_projects import display_project_list
 from examples.widgets.cat.list_todos import display_to_dos
+from examples.widgets.cat.get_project_structure import project_structure_viewer
+from examples.widgets.cat.list_cert_types import display_certifications
 
 # from pyegeria import ServerOps
 from examples.widgets.cli.ops_config import Config
@@ -188,6 +190,28 @@ def show_projects(ctx, search_string):
     display_project_list(search_string, c.view_server, c.view_server_url, c.userid,
                       c.password, False,c.jupyter, c.width)
 
+@show.command('certification-types')
+@click.option('--search-string', default = 'CertificationType', help="")
+@click.pass_context
+def show_certification_types(ctx, search_string):
+    """Show certification types
+        - generally stay with the default..
+    """
+    c = ctx.obj
+    display_certifications(search_string, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.timeout, c.jupyter, c.width)
+
+@show.command('project-structure')
+@click.option('--project', default = 'Clinical Trials Management',
+              help="Enter the root project to start from")
+@click.pass_context
+def show_project_structure(ctx, project):
+    """Show the structure of the project starting from a root project"""
+    c = ctx.obj
+    project_structure_viewer(project, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.jupyter, c.width, c.timeout)
+
+
 
 @show.command('to-dos')
 @click.option('--search-string', default='*',

pyegeria/classification_manager_omvs.py

@@ -45,48 +45,48 @@ def base_path(client, view_server: str):
     return f"{client.platform_url}/servers/{view_server}/api/open-metadata/classification-manager"
 
 
-def extract_relationships_plus(element):
-    type_name = element["relatedElement"]["type"]["typeName"]
-    guid = element["relationshipHeader"]["guid"]
-    properties = element["relationshipProperties"]["propertiesAsStrings"]
-    name = element["relatedElement"]["uniqueName"]
-    return {"name": name, "typeName": type_name, "guid": guid, "properties": properties}
-
-
-def extract_related_elements_list(element_list):
-    return [extract_relationships_plus(element) for element in element_list]
-
-
-def related_elements_response(response: dict, detailed_response: bool):
-    if detailed_response:
-        return response
-    else:
-        return extract_related_elements_list(response["elements"])
-
-
-def element_properties_plus(element):
-    props_plus = element["properties"]
-    props_plus.update({"guid": element["elementHeader"]["guid"]})
-    props_plus.update({"versions": element["elementHeader"]["versions"]})
-    return props_plus
-
-
-def element_property_plus_list(element_list):
-    return [element_properties_plus(element) for element in element_list]
-
-
-def element_response(response: dict, element_type: str, detailed_response: bool):
-    if detailed_response:
-        return response
-    else:
-        return element_properties_plus(response[element_type])
-
-
-def elements_response(response: dict, element_type: str, detailed_response: bool):
-    if detailed_response:
-        return response
-    else:
-        return element_property_plus_list(response[element_type])
+# def extract_relationships_plus(element):
+#     type_name = element["relatedElement"]["type"]["typeName"]
+#     guid = element["relationshipHeader"]["guid"]
+#     properties = element["relationshipProperties"]["propertiesAsStrings"]
+#     name = element["relatedElement"]["uniqueName"]
+#     return {"name": name, "typeName": type_name, "guid": guid, "properties": properties}
+#
+#
+# def extract_related_elements_list(element_list):
+#     return [extract_relationships_plus(element) for element in element_list]
+#
+#
+# def related_elements_response(response: dict, detailed_response: bool):
+#     if detailed_response:
+#         return response
+#     else:
+#         return extract_related_elements_list(response["elements"])
+#
+#
+# def element_properties_plus(element):
+#     props_plus = element["properties"]
+#     props_plus.update({"guid": element["elementHeader"]["guid"]})
+#     props_plus.update({"versions": element["elementHeader"]["versions"]})
+#     return props_plus
+#
+#
+# def element_property_plus_list(element_list):
+#     return [element_properties_plus(element) for element in element_list]
+#
+#
+# def element_response(response: dict, element_type: str, detailed_response: bool):
+#     if detailed_response:
+#         return response
+#     else:
+#         return element_properties_plus(response[element_type])
+#
+#
+# def elements_response(response: dict, element_type: str, detailed_response: bool):
+#     if detailed_response:
+#         return response
+#     else:
+#         return element_property_plus_list(response[element_type])
 
 
 class ClassificationManager(Client):
@@ -121,6 +121,8 @@ class ClassificationManager(Client):
     #
     #   Get elements
     #
+
+
     async def _async_get_elements(self, open_metadata_type_name: str = None, effective_time: str = None,
             for_lineage: bool = None, for_duplicate_processing: bool = None, start_from: int = 0,
             page_size: int = max_paging_size, server_name: str = None, time_out: int = default_time_out) -> list | str:
@@ -1828,3 +1830,718 @@ class ClassificationManager(Client):
         return response
 
 
+    #
+    #   Classification CRUD
+    #
+
+    async def _async_set_confidence_classification(self, element_guid: str, body: dict,
+            for_lineage: bool = None, for_duplicate_processing: bool = None, server_name: str = None,
+                                                   time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization
+        has that the data is complete, accurate and up-to-date.  The level of confidence is expressed by the
+        levelIdentifier property. Async version.
+
+         Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "confidence" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        possible_query_params = query_string(
+            [ ("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/confidence"
+               f"{possible_query_params}"
+              )
+
+        await self._async_make_request("POST", url, body_slimmer(body), time_out=time_out)
+
+
+    def set_confidence_classification(self, element_guid: str, body: dict, for_lineage: bool = None,
+            for_duplicate_processing: bool = None,
+            server_name: str = None, time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization
+        has that the data is complete, accurate and up-to-date.  The level of confidence is expressed by the
+        levelIdentifier property.
+
+         Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "confidence" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_set_confidence_classification(element_guid, body, for_lineage, for_duplicate_processing,
+                 server_name, time_out))
+        
+
+    async def _async_clear_confidence_classification(self, element_guid: str, 
+                                                   for_lineage: bool = None, for_duplicate_processing: bool = None,
+                                                   server_name: str = None,
+                                                   time_out: int = default_time_out) -> None:
+        """
+        Remove the confidence classification from the element.  This normally occurs when the organization has lost 
+        track of the level of confidence to assign to the element. Async Version.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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
+
+        possible_query_params = query_string(
+            [("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/confidence/remove"
+               f"{possible_query_params}"
+               )
+
+        await self._async_make_request("POST", url, time_out=time_out)
+
+    def clear_confidence_classification(self, element_guid: str, for_lineage: bool = None,
+                                      for_duplicate_processing: bool = None,
+                                      server_name: str = None, time_out: int = default_time_out) -> None:
+        """
+        Remove the confidence classification from the element.  This normally occurs when the organization has lost 
+        track of the level of confidence to assign to the element. 
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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()
+        loop.run_until_complete(
+            self._async_clear_confidence_classification(element_guid, for_lineage, for_duplicate_processing,
+                                                      server_name, time_out))
+
+    async def _async_set_confidentiality_classification(self, element_guid: str, body: dict,
+                                                   for_lineage: bool = None, for_duplicate_processing: bool = None,
+                                                   server_name: str = None,
+                                                   time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the
+        level of confidentiality that any data associated with the element should be given.  If the classification is
+        attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the
+        glossary term via the SemanticAssignment classification. The level of confidence is expressed by the
+        levelIdentifier property. Async version.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "confidentiality" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        possible_query_params = query_string(
+            [("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/confidentiality"
+               f"{possible_query_params}"
+               )
+
+        await self._async_make_request("POST", url, body_slimmer(body), time_out=time_out)
+
+    def set_confidentiality_classification(self, element_guid: str, body: dict, for_lineage: bool = None,
+                                      for_duplicate_processing: bool = None,
+                                      server_name: str = None, time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the
+        level of confidentiality that any data associated with the element should be given.  If the classification is
+        attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the
+        glossary term via the SemanticAssignment classification. The level of confidence is expressed by the
+        levelIdentifier property.
+
+         Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "confidentiality" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_set_confidentiality_classification(element_guid, body, for_lineage, for_duplicate_processing,
+                                                      server_name, time_out))
+
+    async def _async_clear_confidentiality_classification(self, element_guid: str,
+                                                     for_lineage: bool = None,
+                                                     for_duplicate_processing: bool = None,
+                                                     server_name: str = None,
+                                                     time_out: int = default_time_out) -> None:
+        """
+        Remove the confidentiality classification from the element.  This normally occurs when the organization has lost 
+        track of the level of confidentiality to assign to the element. Async Version.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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
+
+        possible_query_params = query_string(
+            [("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/confidentiality/remove"
+               f"{possible_query_params}"
+               )
+
+        await self._async_make_request("POST", url,  time_out=time_out)
+
+    def clear_confidentiality_classification(self, element_guid: str, for_lineage: bool = None,
+                                        for_duplicate_processing: bool = None,
+                                        server_name: str = None, time_out: int = default_time_out) -> list | str:
+        """
+        Remove the confidentiality classification from the element.  This normally occurs when the organization has lost 
+        track of the level of confidentiality to assign to the element. 
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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()
+        loop.run_until_complete(
+            self._async_clear_confidentiality_classification(element_guid, for_lineage, for_duplicate_processing,
+                                                        server_name, time_out))
+
+
+    async def _async_set_criticality_classification(self, element_guid: str, body: dict,
+                                                   for_lineage: bool = None, for_duplicate_processing: bool = None,
+                                                   server_name: str = None,
+                                                   time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically an asset) to indicate how critical the element (or
+        associated resource) is to the organization.  The level of criticality is expressed by the levelIdentifier
+        property. Async version.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "criticality" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        possible_query_params = query_string(
+            [("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/criticality"
+               f"{possible_query_params}"
+               )
+
+        await self._async_make_request("POST", url, body_slimmer(body), time_out=time_out)
+
+    def set_criticality_classification(self, element_guid: str, body: dict, for_lineage: bool = None,
+                                      for_duplicate_processing: bool = None,
+                                      server_name: str = None, time_out: int = default_time_out) -> None:
+        """
+        Classify/reclassify the element (typically an asset) to indicate how critical the element (or
+        associated resource) is to the organization.  The level of criticality is expressed by the levelIdentifier
+        property.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        body: dict
+            - a dictionary structure containing the properties to set - see note below
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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.
+
+        Note:
+
+        A sample dict structure is:
+
+        {
+           "class" : "ClassificationRequestBody",
+           "effectiveTime" : "an-isoTimestamp",
+           "properties" : {
+               "class" : "GovernanceClassificationProperties",
+               "levelIdentifier" : 0,
+               "status" : 0,
+               "criticality" : 0,
+               "steward" : "Add value here",
+               "stewardTypeName" : "Add value here",
+               "stewardPropertyName" : "Add value here",
+               "source" : "Add value here",
+               "notes" : "Add value here"
+           }
+        }
+
+        """
+
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_set_criticality_classification(element_guid, body, for_lineage, for_duplicate_processing,
+                                                      server_name, time_out))
+
+    async def _async_clear_criticality_classification(self, element_guid: str,
+                                                     for_lineage: bool = None,
+                                                     for_duplicate_processing: bool = None,
+                                                     server_name: str = None,
+                                                     time_out: int = default_time_out) -> None:
+        """
+        Remove the criticality classification from the element.  This normally occurs when the organization has lost
+        track of the level of criticality to assign to the element. Async Version.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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
+
+        possible_query_params = query_string(
+            [("forLineage", for_lineage), ("forDuplicateProcessing", for_duplicate_processing)])
+
+        url = (f"{base_path(self, server_name)}/elements/{element_guid}/criticality/remove"
+               f"{possible_query_params}"
+               )
+
+        await self._async_make_request("POST", url,  time_out=time_out)
+
+    def clear_criticality_classification(self, element_guid: str, for_lineage: bool = None,
+                                        for_duplicate_processing: bool = None,
+                                        server_name: str = None, time_out: int = default_time_out) -> list | str:
+        """
+        Remove the criticality classification from the element.  This normally occurs when the organization has lost
+        track of the level of criticality to assign to the element.
+
+        Governance Action Classifications: https://egeria-project.org/types/4/0422-Governance-Action-Classifications/
+
+        Parameters
+        ----------
+        element_guid: str
+            - the identity of the element to update
+        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
+        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
+        -------
+        [dict] | str
+            Returns a string if no elements found and a list of dict of elements with the results.
+
+        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()
+        loop.run_until_complete(
+            self._async_clear_criticality_classification(element_guid, for_lineage, for_duplicate_processing,
+                                                        server_name, time_out))
+## Add governance stuff

{pyegeria-0.6.7.dist-info → pyegeria-0.6.8.dist-info}/METADATA

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

{pyegeria-0.6.7.dist-info → pyegeria-0.6.8.dist-info}/RECORD

@@ -4,18 +4,18 @@ examples/widgets/cat/README.md,sha256=-aaAnIT2fcfU63vajgB-RzQk4l4yFdhkyVfSaTPiqR
 examples/widgets/cat/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 examples/widgets/cat/get_asset_graph.py,sha256=Q23n_svJBii58hgaMPLpliN8wqKl4yhnhCCk2IU2nvM,11168
 examples/widgets/cat/get_collection.py,sha256=DBZ5-XkoYsz4WmMSPz0Ao0wz3DlAUQve89KI26-44nc,4613
-examples/widgets/cat/get_project_structure.py,sha256=WHKfoOmqMOVq7KqwNQhLSVS4VH5XxUoVOPdjydvxrso,7564
+examples/widgets/cat/get_project_structure.py,sha256=-ruR649KZoyxJxiITUd9YFq9kn_uxcnybqVTa_7iiic,5692
 examples/widgets/cat/get_tech_type_elements.py,sha256=SvnDWfBIA1NzpkKZj4-ZapIeM2SEhe5jJt7rTkvTzaA,6129
 examples/widgets/cat/get_tech_type_template.py,sha256=gMFVcgCIm09GQu1Vsc5ZUVH9XLhItAG1eVGZJrcnHeQ,6174
 examples/widgets/cat/list_assets.py,sha256=imVun2GB3zoEjaQxKJVGcalI7yZv5Dg_ksb7tYCIVLE,6476
-examples/widgets/cat/list_cert_types.py,sha256=6FmVoNVKz6TRaxQ0XR8IySRCvwKV03wOoY_bSwLgFdU,7005
+examples/widgets/cat/list_cert_types.py,sha256=-FEftRK36pOAXYr8OprvL6T_FcRyVtgfqzSKX74XC5o,7004
 examples/widgets/cat/list_glossary.py,sha256=zljSzVKYysFZVmVhHJt0fYFDmAG9azIphOs4MOIfA7g,5395
 examples/widgets/cat/list_projects.py,sha256=jP6HoVqGi-w4R1itgdAW1zamPLsgkvjvh8reRj0v10Q,7432
 examples/widgets/cat/list_tech_types.py,sha256=20T4v6L5qeebSsaL1nGkFMDAIsy2W3A3SMm1RcgFoh0,4609
 examples/widgets/cat/list_todos.py,sha256=wD9HevGcc4G_bxV25VUz1rRssdZHE33mF5zmJ6Lprt8,5522
 examples/widgets/cli/__init__.py,sha256=6d_R0KZBNnJy9EBz9J2xvGFlx-3j_ZPqPCxKgdvYeDQ,291
-examples/widgets/cli/egeria.py,sha256=jZtQeE9Yzp16t0q6PNAB0LYVoVN6tlSzUvByoCaNR7s,21850
-examples/widgets/cli/egeria_cat.py,sha256=JRLQB0pbYmPYzjlJb_rJAzdZy7-2NWzEH_v-ImKdkKY,9246
+examples/widgets/cli/egeria.py,sha256=t56SnK1vm_PHh13pB19HqfOgAuZz33s-rQwMabsVed8,22907
+examples/widgets/cli/egeria_cat.py,sha256=f9KxOPAEFbeEtSAdk_czcBDLqCKsHkrpdiBuDDo-iUw,10301
 examples/widgets/cli/egeria_my.py,sha256=xi2j1hzNnjDruJeR1qa8K9JPDgzaL_COsMkcieT4Vo8,5653
 examples/widgets/cli/egeria_ops.py,sha256=ZOIQdpRZ5VgL282OpjNVmXvxxmmVxnOaEGF0sNIpzF0,10011
 examples/widgets/cli/egeria_tech.py,sha256=C7eooVyjHTYwA-aEEaeqJgDgJRdmiK0M3dca70bNZYQ,8901
@@ -62,7 +62,7 @@ pyegeria/_validators.py,sha256=DQuMsATRGxGSBtOrVtXlCgWXGhj6Nh-uqPtCsrUGLxk,12703
 pyegeria/action_author_omvs.py,sha256=m0wsfmyO-VxRDaPpACeIDw8eVAFu3RVbo45RPCUel9M,6340
 pyegeria/asset_catalog_omvs.py,sha256=Rlr0RxdJlU6MaapPMGxjqlIqdo46TzNShwx66lTJZvo,25631
 pyegeria/automated_curation_omvs.py,sha256=7mBOXnq06zf1TB3vzo2FPUw2GRLZKKYT2MDQkPxDokk,121332
-pyegeria/classification_manager_omvs.py,sha256=LIrzw7_Ff5gmyeWPR4ClATPgn3PSE2v2Im4gC8L0l-w,86002
+pyegeria/classification_manager_omvs.py,sha256=-W0gj485ZFLB-jNDQnVdcS3JVFJtKICu1WrJJAmFyhU,117153
 pyegeria/collection_manager_omvs.py,sha256=aGtzC3P8_YgY2KEzhtO19_H9drStE0hW5hUj-dA7bLo,112649
 pyegeria/core_omag_server_config.py,sha256=16ld7aBTgO3gGhvFs-_yzwqPsatdCAiKYi005_2evZU,93096
 pyegeria/create_tech_guid_lists.py,sha256=jClpvURy20o4UV83LOwhGg3TZdHGzfjZ9y0MNZyG2To,4282
@@ -78,8 +78,8 @@ pyegeria/runtime_manager_omvs.py,sha256=oSVFeG_yBGXIvQR0EClLZqTZ6C5z5ReZzwm8cce8
 pyegeria/server_operations.py,sha256=ZX7FlJRrAC7RK4bq4wHWepEsYbbWlqkUZdsJrTplVVU,16534
 pyegeria/utils.py,sha256=pkVmS3RrbjaS9yz7FtOCwaOfV5FMqz-__Rt5koCnd9c,5374
 pyegeria/valid_metadata_omvs.py,sha256=aisdRodIwJSkyArAzfm_sEnBELh69xE8k4Nea-vHu8M,36745
-pyegeria-0.6.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.6.7.dist-info/METADATA,sha256=ttWbyY0bkzXaPV4tApSY5u_cgK7KHxZu1KVQUojQjuc,2774
-pyegeria-0.6.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-0.6.7.dist-info/entry_points.txt,sha256=tgDYOGHc_YWRsrz0kyvouqOTdrHgiITKzF3GLVV-GvQ,2727
-pyegeria-0.6.7.dist-info/RECORD,,
+pyegeria-0.6.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.6.8.dist-info/METADATA,sha256=mBa3Vj74k1IYA5CLVgNH4WQktwn3bTTVqjweZDLGQbE,2774
+pyegeria-0.6.8.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-0.6.8.dist-info/entry_points.txt,sha256=tgDYOGHc_YWRsrz0kyvouqOTdrHgiITKzF3GLVV-GvQ,2727
+pyegeria-0.6.8.dist-info/RECORD,,