pyegeria 0.8.4.36__py3-none-any.whl → 0.8.4.37__py3-none-any.whl

pyegeria/valid_metadata_omvs.py

@@ -18,7 +18,7 @@ class ValidMetadataManager(Client):
 
     Attributes:
 
-        server_name: str
+        view_server: str
             The name of the View Server to connect to.
         platform_url : str
             URL of the server platform to connect to
@@ -32,18 +32,23 @@ class ValidMetadataManager(Client):
 
     def __init__(
         self,
-        server_name: str,
+        view_server: str,
         platform_url: str,
         user_id: str = None,
         user_pwd: str = None,
         token: str = None,
     ):
-        self.command_base: str = f"/api/open-metadata/valid-metadata"
+        self.view_server = view_server
+        self.platform_url = platform_url
+        self.user_id = user_id
+        self.user_pwd = user_pwd
+
+        self.valid_m_command_base: str = f"/api/open-metadata/valid-metadata"
         self.page_size = max_paging_size
-        Client.__init__(self, server_name, platform_url, user_id, user_pwd, token=token)
+        Client.__init__(self, view_server, platform_url, user_id, user_pwd, token=token)
 
     async def _async_setup_valid_metadata_value(
-        self, property_name: str, type_name: str, body: dict, server: str = None
+        self, property_name: str, type_name: str, body: dict
     ):
         """Create or update the valid value for a particular open metadata property name. If the typeName is null,
         this valid value applies to properties of this name from all types. The valid value is stored in the
@@ -58,9 +63,7 @@ class ValidMetadataManager(Client):
             The name of the type for the valid metadata value.
         body : dict
             The body of the request containing the details of the valid metadata value.
-        server : str, optional
-            The name of the server where the valid metadata value is being set up.
-            If not provided, the default server name will be used.
+
 
         Returns
         -------
@@ -78,10 +81,9 @@ class ValidMetadataManager(Client):
           "isDeprecated" : false
         }
         """
-        server = self.server_name if server is None else server
 
         url = (
-            f"{self.platform_url}/servers/{server}/api/open-metadata/valid-metadata/setup-value/{property_name}?"
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/valid-metadata/setup-value/{property_name}?"
             f"typeName={type_name}"
         )
 
@@ -89,7 +91,7 @@ class ValidMetadataManager(Client):
         return
 
     def setup_valid_metadata_value(
-        self, property_name: str, type_name: str, body: dict, server: str = None
+        self, property_name: str, type_name: str, body: dict
     ):
         """Create or update the valid value for a particular open metadata property name. If the typeName is null,
         this valid value applies to properties of this name from all types. The valid value is stored in the
@@ -104,9 +106,7 @@ class ValidMetadataManager(Client):
             The name of the type for the valid metadata value.
         body : dict
             The body of the request containing the details of the valid metadata value.
-        server : str, optional
-            The name of the server where the valid metadata value is being set up.
-            If not provided, the default server name will be used.
+
 
         Returns
         -------
@@ -132,14 +132,12 @@ class ValidMetadataManager(Client):
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(
-            self._async_setup_valid_metadata_value(
-                property_name, type_name, body, server
-            )
+            self._async_setup_valid_metadata_value(property_name, type_name, body)
         )
         return
 
     async def _async_setup_valid_metadata_map_name(
-        self, property_name: str, type_name: str, body: dict, server: str = None
+        self, property_name: str, type_name: str, body: dict
     ):
         """Create or update the valid value for a name that can be stored in a particular open metadata property name.
         This property is of type map from name to string. The mapName is stored in the preferredValue property of
@@ -155,8 +153,7 @@ class ValidMetadataManager(Client):
             The type name of the property.
         body : dict
             The metadata map setup data.
-        server : str, optional
-            The name of the server to setup the metadata map. If not provided, the default server name will be used.
+
 
         Returns
         -------
@@ -178,10 +175,9 @@ class ValidMetadataManager(Client):
         }
 
         """
-        server = self.server_name if server is None else server
 
         url = (
-            f"{self.platform_url}/servers/{server}/api/open-metadata/valid-metadata/setup-map-name/{property_name}?"
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/valid-metadata/setup-map-name/{property_name}?"
             f"typeName={type_name}"
         )
 
@@ -189,12 +185,12 @@ class ValidMetadataManager(Client):
         return
 
     async def _async_setup_valid_metadata_type_value(
-        self, property_name: str, type_name: str, map_name: str, server: str = None
+        self, property_name: str, type_name: str, map_name: str
     ):
         pass
 
     async def _async_clear_valid_metadata_value(
-        self, property_name: str, type_name: str, map_name: str, server: str = None
+        self, property_name: str, type_name: str, map_name: str
     ):
         pass
 
@@ -209,22 +205,12 @@ class ValidMetadataManager(Client):
         pass
 
     async def _async_validate_metadata_value(
-        self, property_name: str, type_name: str, actual_value: str, server: str = None
-    ):
-        pass
-
-    async def _async_validate_metadata_map_name(
-        self, property_name: str, type_name: str, map_name: str, server: str = None
-    ):
-        pass
-
-    async def _async_validate_metadata_map_value(
-        self, property_name: str, type_name: str, actual_value: str, server: str = None
+        self, property_name: str, type_name: str, actual_value: str
     ):
         pass
 
     async def _async_validate_metadata_map_name(
-        self, property_name: str, type_name: str, map_name: str, server: str = None
+        self, property_name: str, type_name: str, map_name: str
     ):
         pass
 
@@ -238,7 +224,7 @@ class ValidMetadataManager(Client):
         pass
 
     async def _async_get_valid_metadata_map_name(
-        self, property_name: str, type_name: str, map_name: str, server: str = None
+        self, property_name: str, type_name: str, map_name: str
     ):
         pass
 
@@ -256,7 +242,6 @@ class ValidMetadataManager(Client):
         self,
         property_name: str,
         type_name: str = None,
-        server_name: str = None,
         start_value: int = 0,
         page_size: int = None,
     ) -> list | str:
@@ -269,9 +254,7 @@ class ValidMetadataManager(Client):
         type_name: str, opt
             The Open Metadata type to get the property values for. If not specified then all property values
             will be returned.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -290,13 +273,12 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
+
         if page_size is None:
             page_size = self.page_size
 
         url = (
-            f"{self.platform_url}/servers/{server_name}{self.command_base}/get-valid-metadata-values/{property_name}"
+            f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/get-valid-metadata-values/{property_name}"
             f"?typeName={type_name}&startFrom={start_value}&pageSize={page_size}"
         )
 
@@ -304,7 +286,7 @@ class ValidMetadataManager(Client):
         return resp.json().get("elementList", "No elements found")
 
     def get_valid_metadata_values(
-        self, property_name: str, type_name: str = None, server_name: str = None
+        self, property_name: str, type_name: str = None
     ) -> list | str:
         """Retrieve list of values for the property.
 
@@ -315,71 +297,7 @@ class ValidMetadataManager(Client):
         type_name: str, opt
             The Open Metadata type to get the property values for. If not specified then all property values
             will be returned.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
 
-        Returns
-        -------
-        List | str
-
-        A list of collections linked off of the supplied element.
-
-        Raises
-        ------
-
-        InvalidParameterException
-          If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-        PropertyServerException
-          Raised by the server when an issue arises in processing a valid request
-        NotAuthorizedException
-          The principle specified by the user_id does not have authorization for the requested action
-
-        """
-        loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(
-            self._async_get_valid_metadata_values(property_name, type_name, server_name)
-        )
-        return resp
-
-    async def _async_get_valid_metadata_value(
-        self,
-        property_name: str,
-        type_name: str,
-        preferred_value: str,
-        server_name: str = None,
-    ) -> list | str:
-        if server_name is None:
-            server_name = self.server_name
-
-        url = (
-            f"{self.platform_url}/servers/{server_name}{self.command_base}/get-value/{property_name}"
-            f"?typeName={type_name}&preferredValue={preferred_value}"
-        )
-
-        resp = await self._async_make_request("GET", url)
-        return resp.json()
-
-    def get_valid_metadata_value(
-        self,
-        property_name: str,
-        type_name: str,
-        preferred_value: str,
-        server_name: str = None,
-    ) -> list | str:
-        """Retrieve details of a specific valid value for a property.
-
-        Parameters
-        ----------
-        property_name: str
-            The property name of the valid metadata value to retrieve
-        type_name: str
-            Type of the metadata value to retrieve
-        preferred_value: str
-            The preferred value of the valid metadata value to retrieve
-        server_name : str, opt
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
 
         Returns
         -------
@@ -399,12 +317,8 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = (
-            loop.run_until_complete(
-                self._async_get_valid_metadata_value(
-                    property_name, type_name, preferred_value, server_name
-                )
-            ),
+        resp = loop.run_until_complete(
+            self._async_get_valid_metadata_values(property_name, type_name)
         )
         return resp
 
@@ -414,7 +328,6 @@ class ValidMetadataManager(Client):
         type_name: str,
         map_name: str,
         preferred_value: str,
-        server_name: str = None,
         start_from: int = 0,
         page_size: int = None,
     ) -> list | str:
@@ -430,9 +343,7 @@ class ValidMetadataManager(Client):
             A valid map name that associates a property with a value.
         preferred_value : str
 
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
         start_from: int, [default=0], optional
                     When multiple pages of results are available, the page number to start from.
         page_size: int, [default=None]
@@ -455,13 +366,12 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
+
         if page_size is None:
             page_size = self.page_size
 
         url = (
-            f"{self.platform_url}/servers/{server_name}{self.command_base}/{property_name}/"
+            f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/{property_name}/"
             f"consistent-metadata-values?typeName={type_name}&mapName={map_name}&preferredValue={preferred_value}"
             f"&startFrom={start_from}&pageSize={page_size}"
         )
@@ -475,7 +385,6 @@ class ValidMetadataManager(Client):
         type_name: str,
         map_name: str,
         preferred_value: str,
-        server_name: str = None,
         start_from: int = 0,
         page_size: int = None,
     ) -> list | str:
@@ -491,9 +400,7 @@ class ValidMetadataManager(Client):
             A valid map name that associates a property with a value.
         preferred_value : str
 
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
         start_from: int, [default=0], optional
                     When multiple pages of results are available, the page number to start from.
         page_size: int, [default=None]
@@ -523,7 +430,6 @@ class ValidMetadataManager(Client):
                 type_name,
                 map_name,
                 preferred_value,
-                server_name,
                 start_from,
                 page_size,
             )
@@ -533,7 +439,7 @@ class ValidMetadataManager(Client):
     #
     # Get all ...
     #
-    async def _async_get_all_entity_types(self, server_name: str = None) -> list | str:
+    async def _async_get_all_entity_types(self) -> list | str:
         """Returns the list of different types of metadata organized into two groups.  The first are the
             attribute type definitions (AttributeTypeDefs).  These provide types for attributes in full
             type definitions.  Full type definitions (TypeDefs) describe types for entities, relationships
@@ -541,9 +447,7 @@ class ValidMetadataManager(Client):
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -562,15 +466,13 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types"
+        url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types"
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_all_entity_types(self, server_name: str = None) -> list | str:
+    def get_all_entity_types(self) -> list | str:
         """Returns the list of different types of metadata organized into two groups.  The first are the
             attribute type definitions (AttributeTypeDefs).  These provide types for attributes in full
             type definitions.  Full type definitions (TypeDefs) describe types for entities, relationships
@@ -578,9 +480,7 @@ class ValidMetadataManager(Client):
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -600,17 +500,15 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(self._async_get_all_entity_types(server_name))
+        resp = loop.run_until_complete(self._async_get_all_entity_types())
         return resp
 
-    async def _async_get_all_entity_defs(self, server_name: str = None) -> list | str:
+    async def _async_get_all_entity_defs(self) -> list | str:
         """GReturns all the entity type definitions. Async version.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -629,22 +527,18 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/entity-defs"
+        url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/entity-defs"
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_all_entity_defs(self, server_name: str = None) -> list | str:
+    def get_all_entity_defs(self) -> list | str:
         """Returns all the entity type definitions.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -664,19 +558,15 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(self._async_get_all_entity_defs(server_name))
+        resp = loop.run_until_complete(self._async_get_all_entity_defs())
         return resp
 
-    async def _async_get_all_relationship_defs(
-        self, server_name: str = None
-    ) -> list | str:
+    async def _async_get_all_relationship_defs(self) -> list | str:
         """Returns all the relationship type definitions. Async version.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -695,22 +585,18 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/relationship-defs"
+        url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/relationship-defs"
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_all_relationship_defs(self, server_name: str = None) -> list | str:
+    def get_all_relationship_defs(self) -> list | str:
         """Returns all the relationship type definitions.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -730,21 +616,15 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(
-            self._async_get_all_relationship_defs(server_name)
-        )
+        resp = loop.run_until_complete(self._async_get_all_relationship_defs())
         return resp
 
-    async def _async_get_all_classification_defs(
-        self, server_name: str = None
-    ) -> list | str:
+    async def _async_get_all_classification_defs(self) -> list | str:
         """Returns all the classification type definitions. Async version.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -763,22 +643,18 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/classification-defs"
+        url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/classification-defs"
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_all_classification_defs(self, server_name: str = None) -> list | str:
+    def get_all_classification_defs(self) -> list | str:
         """Returns all the classification type definitions.
 
         Parameters
         ----------
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -798,17 +674,13 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(
-            self._async_get_all_classification_defs(server_name)
-        )
+        resp = loop.run_until_complete(self._async_get_all_classification_defs())
         return resp
 
     #
     # Get valid ...
     #
-    async def _async_get_valid_relationship_types(
-        self, entity_type: str, server_name: str = None
-    ) -> list | str:
+    async def _async_get_valid_relationship_types(self, entity_type: str) -> list | str:
         """Returns all the TypeDefs for relationships that can be attached to the requested entity type.
             Async version.
 
@@ -816,9 +688,7 @@ class ValidMetadataManager(Client):
         ----------
         entity_type : str
             The name of the entity type to retrieve the valid relationships for.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -837,20 +707,16 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
         url = (
-            f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/{entity_type}/"
+            f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/{entity_type}/"
             f"attached-relationships"
         )
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_valid_relationship_types(
-        self, entity_type: str, server_name: str = None
-    ) -> list | str:
+    def get_valid_relationship_types(self, entity_type: str) -> list | str:
         """Returns all the TypeDefs for relationships that can be attached to the requested entity type.
                     Async version.
 
@@ -858,7 +724,7 @@ class ValidMetadataManager(Client):
             ----------
             entity_type : str
                  The name of the entity type to retrieve the valid relationships for.
-            server_name : str, optional
+             : str, optional
                 The name of the server to  configure.
                 If not provided, the server name associated with the instance is used.
 
@@ -881,12 +747,12 @@ class ValidMetadataManager(Client):
         """
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
-            self._async_get_valid_relationship_types(entity_type, server_name)
+            self._async_get_valid_relationship_types(entity_type)
         )
         return resp
 
     async def _async_get_valid_classification_types(
-        self, entity_type: str, server_name: str = None
+        self, entity_type: str
     ) -> list | str:
         """Returns all the TypeDefs for classifications that can be attached to the requested entity type.
             Async version.
@@ -895,9 +761,7 @@ class ValidMetadataManager(Client):
         ----------
         entity_type : str
             The name of the entity type to retrieve the classifications for.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -916,20 +780,16 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
         url = (
-            f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/{entity_type}/"
+            f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/{entity_type}/"
             f"attached-classifications"
         )
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDefs", "No TypeDefs Found")
 
-    def get_valid_classification_types(
-        self, entity_type: str, server_name: str = None
-    ) -> list | str:
+    def get_valid_classification_types(self, entity_type: str) -> list | str:
         """Returns all the TypeDefs for relationships that can be attached to the requested entity type.
                     Async version.
 
@@ -937,7 +797,7 @@ class ValidMetadataManager(Client):
             ----------
             entity_type : str
                 The name of the entity type to retrieve the classifications for.
-            server_name : str, optional
+             : str, optional
                 The name of the server to  configure.
                 If not provided, the server name associated with the instance is used.
 
@@ -960,13 +820,11 @@ class ValidMetadataManager(Client):
         """
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
-            self._async_get_valid_classification_types(entity_type, server_name)
+            self._async_get_valid_classification_types(entity_type)
         )
         return resp
 
-    async def _async_get_typedef_by_name(
-        self, entity_type: str, server_name: str = None
-    ) -> dict | str:
+    async def _async_get_typedef_by_name(self, entity_type: str) -> dict | str:
         """Return the TypeDef identified by the unique name.
             Async version.
 
@@ -974,9 +832,7 @@ class ValidMetadataManager(Client):
         ----------
         entity_type : str
             The name of the entity type to retrieve the typedef for.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -995,26 +851,20 @@ class ValidMetadataManager(Client):
           The principle specified by the user_id does not have authorization for the requested action
 
         """
-        if server_name is None:
-            server_name = self.server_name
 
-        url = f"{self.platform_url}/servers/{server_name}{self.command_base}/open-metadata-types/name/{entity_type}"
+        url = f"{self.platform_url}/servers/{self.view_server}{self.valid_m_command_base}/open-metadata-types/name/{entity_type}"
 
         resp = await self._async_make_request("GET", url)
         return resp.json().get("typeDef", "No TypeDefs Found")
 
-    def get_typedef_by_name(
-        self, entity_type: str, server_name: str = None
-    ) -> dict | str:
+    def get_typedef_by_name(self, entity_type: str) -> dict | str:
         """Return the TypeDef identified by the unique name.
 
         Parameters
         ----------
         entity_type : str
             The name of the entity type to retrieve the typedef for.
-        server_name : str, optional
-            The name of the server to  configure.
-            If not provided, the server name associated with the instance is used.
+
 
         Returns
         -------
@@ -1034,9 +884,7 @@ class ValidMetadataManager(Client):
 
         """
         loop = asyncio.get_event_loop()
-        resp = loop.run_until_complete(
-            self._async_get_typedef_by_name(entity_type, server_name)
-        )
+        resp = loop.run_until_complete(self._async_get_typedef_by_name(entity_type))
         return resp