pyegeria 0.8.4.17__py3-none-any.whl → 0.8.4.18__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,6 +21,8 @@ from pyegeria import (
21
21
  ClassificationManager,
22
22
  RegisteredInfo,
23
23
  RuntimeManager,
24
+ TEMPLATE_GUIDS,
25
+ INTEGRATION_GUIDS,
24
26
  )
25
27
 
26
28
 
@@ -42,13 +42,13 @@ class RuntimeManager(Client):
42
42
  user_pwd: str = None,
43
43
  token: str = None,
44
44
  ):
45
+ self.view_server = view_server
45
46
  Client.__init__(self, view_server, platform_url, user_id, user_pwd, token=token)
46
- self.cur_command_root = f"{platform_url}/servers/"
47
+ self.cur_command_root = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager"
47
48
  self.platform_guid = "44bf319f-1e41-4da1-b771-2753b92b631a" # this is platform @ 9443 from the core content archive
48
49
  self.default_platform_name = (
49
50
  "Default Local OMAG Server Platform" # this from the core content archive
50
51
  )
51
- self.view_server = view_server
52
52
 
53
53
  async def _async_connect_to_cohort(
54
54
  self,
@@ -82,7 +82,7 @@ class RuntimeManager(Client):
82
82
  """
83
83
 
84
84
  url = (
85
- f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
85
+ f"{self.cur_command_root}/cohort-members/"
86
86
  f"{server_guid}/cohorts/{cohort_name}/connect"
87
87
  )
88
88
  await self._async_make_request("GET", url)
@@ -149,7 +149,7 @@ class RuntimeManager(Client):
149
149
  """
150
150
 
151
151
  url = (
152
- f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
152
+ f"{self.cur_command_root}/cohort-members/"
153
153
  f"{server_guid}/cohorts/{cohort_name}/disconnect"
154
154
  )
155
155
  await self._async_make_request("GET", url)
@@ -213,7 +213,7 @@ class RuntimeManager(Client):
213
213
  """
214
214
 
215
215
  url = (
216
- f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
216
+ f"{self.cur_command_root}/cohort-members/"
217
217
  f"{server_guid}/cohorts/{cohort_name}/unregister"
218
218
  )
219
219
  await self._async_make_request("GET", url)
@@ -282,7 +282,7 @@ class RuntimeManager(Client):
282
282
  """
283
283
 
284
284
  url = (
285
- f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/engine-hosts/"
285
+ f"{self.cur_command_root}/engine-hosts/"
286
286
  f"{server_guid}/governance_engines/{gov_engine_name}/refresh-config"
287
287
  )
288
288
  await self._async_make_request("GET", url)
@@ -323,51 +323,114 @@ class RuntimeManager(Client):
323
323
  )
324
324
  return
325
325
 
326
+ async def _async_get_config_properties(
327
+ self,
328
+ server_guid: str,
329
+ connector_name: str,
330
+ ) -> dict | str:
331
+ """Retrieve the configuration properties of the named integration connector running in the integration daemon.
332
+ Async version.
333
+
334
+ https://egeria-project.org/concepts/integration-connector/
335
+
336
+ Parameters
337
+ ----------
338
+ server_guid : str
339
+ Identity of the server to act on.
340
+ connector_name : str
341
+ Name of the integration connector to retrieve properties for.
342
+
343
+ Returns
344
+ -------
345
+ Dict of the connector configuration properties.
346
+
347
+ Raises
348
+ ------
349
+ InvalidParameterException
350
+ PropertyServerException
351
+ UserNotAuthorizedException
352
+
353
+ """
354
+
355
+ url = (
356
+ f"{self.cur_command_root}/integration-daemons/"
357
+ f"{server_guid}/integration-connectors/{connector_name}/configuration-properties"
358
+ )
359
+ response = await self._async_make_request("GET", url)
360
+ return response.json().get("properties", "No pproperties found")
361
+
362
+ def get_config_properties(
363
+ self,
364
+ server_guid: str,
365
+ connector_name: str,
366
+ ) -> dict | str:
367
+ """Retrieve the configuration properties of the named integration connector running in the integration daemon.
368
+ Async version.
369
+
370
+ https://egeria-project.org/concepts/integration-connector/
371
+
372
+ Parameters
373
+ ----------
374
+ server_guid : str
375
+ Identity of the server to act on.
376
+ connector_name : str
377
+ Name of the integration connector to retrieve properties for.
378
+ Returns
379
+ -------
380
+ None
381
+
382
+ Raises
383
+ ------
384
+ InvalidParameterException
385
+ PropertyServerException
386
+ UserNotAuthorizedException
387
+
388
+ """
389
+ loop = asyncio.get_event_loop()
390
+ response = loop.run_until_complete(
391
+ self._async_get_config_properties(server_guid, connector_name)
392
+ )
393
+ return response
394
+
326
395
  async def _async_get_platforms_by_name(
327
396
  self,
328
397
  filter: str = None,
329
- view_server: str = None,
330
398
  effective_time: str = None,
331
399
  start_from: int = 0,
332
400
  page_size: int = max_paging_size,
333
401
  ) -> str | list:
334
402
  """Returns the list of platforms with a particular name. The name is specified in the filter. Async version.
335
- Parameters
336
- ----------
403
+ Parameters
404
+ ----------
337
405
  filter : str, opt
338
- Filter specifies the display name or qualified name of the platforms to return information for. If the
339
- value is None, we will default to the default_platform_name that comes from the core content pack.
340
-
341
- view_server : str, optional
342
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
343
- will be used.
344
-
345
- start_from : int, optional
346
- The index from which to start fetching the engine actions. Default is 0.
406
+ Filter specifies the display name or qualified name of the platforms to return information for. If the
407
+ value is None, we will default to the default_platform_name that comes from the core content pack.
408
+ effective_time: str, optional
409
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
410
+ start_from : int, optional
411
+ The index from which to start fetching the engine actions. Default is 0.
347
412
 
348
- page_size : int, optional
349
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
413
+ page_size : int, optional
414
+ The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
350
415
 
351
- Returns
352
- -------
353
- Response
354
- A lit of json dict with the platform reports.
416
+ Returns
417
+ -------
418
+ Response
419
+ A lit of json dict with the platform reports.
355
420
 
356
- Raises
357
- ------
358
- InvalidParameterException
359
- PropertyServerException
360
- UserNotAuthorizedException
421
+ Raises
422
+ ------
423
+ InvalidParameterException
424
+ PropertyServerException
425
+ UserNotAuthorizedException
361
426
 
362
427
  """
363
- if view_server is None:
364
- view_server = self.view_server
365
428
 
366
429
  if filter is None:
367
430
  filter = self.default_platform_name
368
431
 
369
432
  url = (
370
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/by-name?"
433
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/platforms/by-name?"
371
434
  f"startFrom={start_from}&pageSize={page_size}"
372
435
  )
373
436
  if effective_time is not None:
@@ -382,7 +445,6 @@ class RuntimeManager(Client):
382
445
  def get_platforms_by_name(
383
446
  self,
384
447
  filter: str = None,
385
- view_server: str = None,
386
448
  effective_time: str = None,
387
449
  start_from: int = 0,
388
450
  page_size: int = max_paging_size,
@@ -394,15 +456,10 @@ class RuntimeManager(Client):
394
456
  filter : str, opt
395
457
  Filter specifies the display name or qualified name of the platforms to return information for. If the
396
458
  value is None, we will default to the default_platform_name that comes from the core content pack.
397
-
398
- view_server : str, optional
399
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
400
- will be used.
401
-
459
+ effective_time: str, optional
460
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
402
461
  start_from : int, optional
403
462
  The index from which to start fetching the engine actions. Default is 0.
404
-
405
-
406
463
  page_size : int, optional
407
464
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
408
465
 
@@ -420,7 +477,7 @@ class RuntimeManager(Client):
420
477
  loop = asyncio.get_event_loop()
421
478
  response = loop.run_until_complete(
422
479
  self._async_get_platforms_by_name(
423
- filter, view_server, effective_time, start_from, page_size
480
+ filter, effective_time, start_from, page_size
424
481
  )
425
482
  )
426
483
  return response
@@ -428,7 +485,6 @@ class RuntimeManager(Client):
428
485
  async def _async_get_platforms_by_type(
429
486
  self,
430
487
  filter: str = None,
431
- view_server: str = None,
432
488
  effective_time: str = None,
433
489
  start_from: int = 0,
434
490
  page_size: int = max_paging_size,
@@ -441,14 +497,10 @@ class RuntimeManager(Client):
441
497
  filter : str, opt
442
498
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
443
499
  If the value is None, we will default to the "OMAG Server Platform".
444
-
445
- view_server : str, optional
446
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
447
- will be used.
448
-
500
+ effective_time: str, optional
501
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
449
502
  start_from : int, optional
450
503
  The index from which to start fetching the engine actions. Default is 0.
451
-
452
504
  page_size : int, optional
453
505
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
454
506
 
@@ -464,14 +516,12 @@ class RuntimeManager(Client):
464
516
  UserNotAuthorizedException
465
517
 
466
518
  """
467
- if view_server is None:
468
- view_server = self.view_server
469
519
 
470
520
  if filter is None:
471
521
  filter = "OMAG Server Platform"
472
522
 
473
523
  url = (
474
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/"
524
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/platforms/"
475
525
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}"
476
526
  )
477
527
 
@@ -486,7 +536,6 @@ class RuntimeManager(Client):
486
536
  def get_platforms_by_type(
487
537
  self,
488
538
  filter: str = None,
489
- view_server: str = None,
490
539
  effective_time: str = None,
491
540
  start_from: int = 0,
492
541
  page_size: int = max_paging_size,
@@ -499,15 +548,10 @@ class RuntimeManager(Client):
499
548
  filter : str, opt
500
549
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
501
550
  If the value is None, we will default to the "OMAG Server Platform".
502
-
503
- view_server : str, optional
504
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
505
- will be used.
506
-
551
+ effective_time: str, optional
552
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
507
553
  start_from : int, optional
508
554
  The index from which to start fetching the engine actions. Default is 0.
509
-
510
-
511
555
  page_size : int, optional
512
556
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
513
557
 
@@ -526,7 +570,7 @@ class RuntimeManager(Client):
526
570
  loop = asyncio.get_event_loop()
527
571
  response = loop.run_until_complete(
528
572
  self._async_get_platforms_by_type(
529
- filter, view_server, effective_time, start_from, page_size
573
+ filter, effective_time, start_from, page_size
530
574
  )
531
575
  )
532
576
  return response
@@ -534,7 +578,6 @@ class RuntimeManager(Client):
534
578
  async def _async_get_platform_templates_by_type(
535
579
  self,
536
580
  filter: str = None,
537
- view_server: str = None,
538
581
  effective_time: str = None,
539
582
  start_from: int = 0,
540
583
  page_size: int = max_paging_size,
@@ -548,14 +591,10 @@ class RuntimeManager(Client):
548
591
  filter : str, opt
549
592
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
550
593
  If the value is None, we will default to the "OMAG Server Platform".
551
-
552
- view_server : str, optional
553
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
554
- will be used.
555
-
594
+ effective_time: str, optional
595
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
556
596
  start_from : int, optional
557
597
  The index from which to start fetching the engine actions. Default is 0.
558
-
559
598
  page_size : int, optional
560
599
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
561
600
 
@@ -571,14 +610,12 @@ class RuntimeManager(Client):
571
610
  UserNotAuthorizedException
572
611
 
573
612
  """
574
- if view_server is None:
575
- view_server = self.view_server
576
613
 
577
614
  if filter is None:
578
615
  filter = "OMAG Server Platform"
579
616
 
580
617
  url = (
581
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/"
618
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/platforms/"
582
619
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}&getTemplates=true"
583
620
  )
584
621
 
@@ -593,7 +630,6 @@ class RuntimeManager(Client):
593
630
  def get_platform_templates_by_type(
594
631
  self,
595
632
  filter: str = None,
596
- view_server: str = None,
597
633
  effective_time: str = None,
598
634
  start_from: int = 0,
599
635
  page_size: int = max_paging_size,
@@ -606,15 +642,10 @@ class RuntimeManager(Client):
606
642
  filter : str, opt
607
643
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
608
644
  If the value is None, we will default to the "OMAG Server Platform".
609
-
610
- view_server : str, optional
611
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
612
- will be used.
613
-
645
+ effective_time: str, optional
646
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
614
647
  start_from : int, optional
615
648
  The index from which to start fetching the engine actions. Default is 0.
616
-
617
-
618
649
  page_size : int, optional
619
650
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
620
651
 
@@ -633,14 +664,12 @@ class RuntimeManager(Client):
633
664
  loop = asyncio.get_event_loop()
634
665
  response = loop.run_until_complete(
635
666
  self._async_get_platforms_by_type(
636
- filter, view_server, effective_time, start_from, page_size
667
+ filter, effective_time, start_from, page_size
637
668
  )
638
669
  )
639
670
  return response
640
671
 
641
- async def _async_get_platform_report(
642
- self, platform_guid: str = None, view_server: str = None
643
- ) -> str | list:
672
+ async def _async_get_platform_report(self, platform_guid: str = None) -> str | list:
644
673
  """Returns details about the running platform. Async version.
645
674
 
646
675
  Parameters
@@ -648,10 +677,6 @@ class RuntimeManager(Client):
648
677
  platform_guid : str
649
678
  The unique identifier for the platform.
650
679
 
651
- view_server : str, optional
652
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
653
- will be used.
654
-
655
680
  Returns
656
681
  -------
657
682
  Response
@@ -664,18 +689,14 @@ class RuntimeManager(Client):
664
689
  UserNotAuthorizedException
665
690
 
666
691
  """
667
- if view_server is None:
668
- view_server = self.view_server
669
692
 
670
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}/report"
693
+ url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}/report"
671
694
 
672
695
  response = await self._async_make_request("GET", url)
673
696
 
674
697
  return response.json().get("element", "No platforms found")
675
698
 
676
- def get_platform_report(
677
- self, platform_guid: str = None, view_server: str = None
678
- ) -> str | list:
699
+ def get_platform_report(self, platform_guid: str = None) -> str | list:
679
700
  """Returns details about the running platform.
680
701
 
681
702
  Parameters
@@ -683,11 +704,6 @@ class RuntimeManager(Client):
683
704
  platform_guid : str
684
705
  The unique identifier for the platform.
685
706
 
686
- view_server : str, optional
687
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
688
- will be used.
689
-
690
-
691
707
  Returns
692
708
  -------
693
709
  Response
@@ -702,45 +718,33 @@ class RuntimeManager(Client):
702
718
  """
703
719
  loop = asyncio.get_event_loop()
704
720
  response = loop.run_until_complete(
705
- self._async_get_platform_report(platform_guid, view_server)
721
+ self._async_get_platform_report(platform_guid)
706
722
  )
707
723
  return response
708
724
 
709
725
  async def _async_get_platform_by_guid(
710
726
  self,
711
- platform_guid: str = None,
712
- view_server: str = None,
727
+ platform_guid: str,
713
728
  effective_time: str = None,
714
729
  ) -> str | list:
715
730
  """Returns details about the platform's catalog entry (asset). Async version.
716
731
 
717
732
  Parameters
718
733
  ----------
719
- filter : str, opt
720
- Filter specifies the kind of deployed implementation type of the platforms to return information for.
721
- If the value is None, we will default to the "OMAG Server Platform".
722
-
723
- view_server : str, optional
724
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
725
- will be used.
726
-
727
- start_from : int, optional
728
- The index from which to start fetching the engine actions. Default is 0.
734
+ platform_guid : str
735
+ Unique id of the platform to return details of.
736
+ effective_time: str, optional
737
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
729
738
 
730
739
 
731
- page_size : int, optional
732
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
733
-
734
740
  Returns
735
741
  -------
736
742
  Response
737
- A lit of json dict with the platform reports.
743
+ A list of json dict with the platform reports.
738
744
 
739
745
  """
740
- if view_server is None:
741
- view_server = self.view_server
742
746
 
743
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}"
747
+ url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}"
744
748
 
745
749
  if effective_time is not None:
746
750
  body = {"effectiveTime": effective_time}
@@ -753,28 +757,17 @@ class RuntimeManager(Client):
753
757
 
754
758
  def get_platform_by_guid(
755
759
  self,
756
- platform_guid: str = None,
757
- view_server: str = None,
760
+ platform_guid: str,
758
761
  effective_time: str = None,
759
762
  ) -> str | list:
760
763
  """Returns details about the platform's catalog entry (asset).
761
764
 
762
765
  Parameters
763
766
  ----------
764
- filter : str, opt
765
- Filter specifies the kind of deployed implementation type of the platforms to return information for.
766
- If the value is None, we will default to the "OMAG Server Platform".
767
-
768
- view_server : str, optional
769
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
770
- will be used.
771
-
772
- start_from : int, optional
773
- The index from which to start fetching the engine actions. Default is 0.
774
-
775
-
776
- page_size : int, optional
777
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
767
+ platform_guid : str, opt
768
+ Identity of the platform to return details about.
769
+ effective_time: str, optional
770
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
778
771
 
779
772
  Returns
780
773
  -------
@@ -790,14 +783,12 @@ class RuntimeManager(Client):
790
783
  """
791
784
  loop = asyncio.get_event_loop()
792
785
  response = loop.run_until_complete(
793
- self._async_get_platforms_by_guid(
794
- platform_guid, view_server, effective_time
795
- )
786
+ self._async_get_platform_by_guid(platform_guid, effective_time)
796
787
  )
797
788
  return response
798
789
 
799
790
  async def _async_get_server_by_guid(
800
- self, server_guid: str, view_server: str = None, effective_time: str = None
791
+ self, server_guid: str, effective_time: str = None
801
792
  ) -> str | dict:
802
793
  """Returns details about the server's catalog entry (asset). Async version.
803
794
 
@@ -805,10 +796,8 @@ class RuntimeManager(Client):
805
796
  ----------
806
797
  server_guid : str
807
798
  The unique identifier for the platform.
808
-
809
- view_server : str, optional
810
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
811
- will be used.
799
+ effective_time: str, optional
800
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
812
801
 
813
802
  Returns
814
803
  -------
@@ -822,10 +811,8 @@ class RuntimeManager(Client):
822
811
  UserNotAuthorizedException
823
812
 
824
813
  """
825
- if view_server is None:
826
- view_server = self.view_server
827
814
 
828
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
815
+ url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
829
816
 
830
817
  if effective_time is not None:
831
818
  body = {"effectiveTime": effective_time}
@@ -834,10 +821,10 @@ class RuntimeManager(Client):
834
821
  else:
835
822
  response = await self._async_make_request("POST", url)
836
823
 
837
- return response.json().get("elements", "No view_server found")
824
+ return response.json().get("elements", "No server found")
838
825
 
839
826
  def get_server_by_guid(
840
- self, server_guid: str, view_server: str = None, effective_time: str = None
827
+ self, server_guid: str, effective_time: str = None
841
828
  ) -> str | dict:
842
829
  """Returns details about the platform's catalog entry (asset).
843
830
 
@@ -845,10 +832,8 @@ class RuntimeManager(Client):
845
832
  ----------
846
833
  server_guid : str
847
834
  The unique identifier for the platform.
848
-
849
- view_server : str, optional
850
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
851
- will be used.
835
+ effective_time: str, optional
836
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
852
837
 
853
838
  Returns
854
839
  -------
@@ -864,14 +849,13 @@ class RuntimeManager(Client):
864
849
  """
865
850
  loop = asyncio.get_event_loop()
866
851
  response = loop.run_until_complete(
867
- self._async_get_server_by_guid(server_guid, view_server, effective_time)
852
+ self._async_get_server_by_guid(server_guid, effective_time)
868
853
  )
869
854
  return response
870
855
 
871
856
  async def _async_get_servers_by_name(
872
857
  self,
873
858
  filter: str,
874
- view_server: str = None,
875
859
  effective_time: str = None,
876
860
  start_from: int = 0,
877
861
  page_size: int = max_paging_size,
@@ -883,15 +867,10 @@ class RuntimeManager(Client):
883
867
  filter : str, opt
884
868
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
885
869
  If the value is None, we will default to the "OMAG Server Platform".
886
-
887
- view_server : str, optional
888
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
889
- will be used.
890
-
870
+ effective_time: str, optional
871
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
891
872
  start_from : int, optional
892
873
  The index from which to start fetching the engine actions. Default is 0.
893
-
894
-
895
874
  page_size : int, optional
896
875
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
897
876
 
@@ -907,11 +886,9 @@ class RuntimeManager(Client):
907
886
  UserNotAuthorizedException
908
887
 
909
888
  """
910
- if view_server is None:
911
- view_server = self.view_server
912
889
 
913
890
  url = (
914
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/by-name?"
891
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/software-servers/by-name?"
915
892
  f"startFrom={start_from}&pageSize={page_size}"
916
893
  )
917
894
 
@@ -923,7 +900,9 @@ class RuntimeManager(Client):
923
900
 
924
901
  return response.json().get("elements", "No platforms found")
925
902
 
926
- def get_servers_by_name(self, filter: str, view_server: str = None) -> str | list:
903
+ def get_servers_by_name(
904
+ self, filter: str, effective_time: str = None
905
+ ) -> str | list:
927
906
  """Returns the list of servers with a particular name. The name is specified in the filter.
928
907
 
929
908
  Parameters
@@ -931,17 +910,8 @@ class RuntimeManager(Client):
931
910
  filter : str, opt
932
911
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
933
912
  If the value is None, we will default to the "OMAG Server Platform".
934
-
935
- view_server : str, optional
936
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
937
- will be used.
938
-
939
- start_from : int, optional
940
- The index from which to start fetching the engine actions. Default is 0.
941
-
942
-
943
- page_size : int, optional
944
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
913
+ effective_time: str, optional
914
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
945
915
 
946
916
  Returns
947
917
  -------
@@ -957,14 +927,13 @@ class RuntimeManager(Client):
957
927
  """
958
928
  loop = asyncio.get_event_loop()
959
929
  response = loop.run_until_complete(
960
- self._async_get_servers_by_name(filter, view_server)
930
+ self._async_get_servers_by_name(filter, effective_time)
961
931
  )
962
932
  return response
963
933
 
964
934
  async def _async_get_servers_by_dep_impl_type(
965
935
  self,
966
936
  filter: str = "*",
967
- view_server: str = None,
968
937
  effective_time: str = None,
969
938
  start_from: int = 0,
970
939
  page_size: int = max_paging_size,
@@ -978,15 +947,10 @@ class RuntimeManager(Client):
978
947
  filter : str, opt
979
948
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
980
949
  If the value is None, we will default to the "OMAG Server Platform".
981
-
982
- view_server : str, optional
983
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
984
- will be used.
985
-
950
+ effective_time: str, optional
951
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
986
952
  start_from : int, optional
987
953
  The index from which to start fetching the engine actions. Default is 0.
988
-
989
-
990
954
  page_size : int, optional
991
955
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
992
956
 
@@ -1002,14 +966,12 @@ class RuntimeManager(Client):
1002
966
  UserNotAuthorizedException
1003
967
 
1004
968
  """
1005
- if view_server is None:
1006
- view_server = self.view_server
1007
969
 
1008
970
  if filter == "*":
1009
971
  filter = None
1010
972
 
1011
973
  url = (
1012
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/"
974
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/software-servers/"
1013
975
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}"
1014
976
  )
1015
977
 
@@ -1022,7 +984,6 @@ class RuntimeManager(Client):
1022
984
  def get_servers_by_dep_impl_type(
1023
985
  self,
1024
986
  filter: str = "*",
1025
- view_server: str = None,
1026
987
  effective_time: str = None,
1027
988
  start_from: int = 0,
1028
989
  page_size: int = max_paging_size,
@@ -1036,15 +997,10 @@ class RuntimeManager(Client):
1036
997
  filter : str, opt
1037
998
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
1038
999
  If the value is None, we will default to the "OMAG Server Platform".
1039
-
1040
- view_server : str, optional
1041
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1042
- will be used.
1043
-
1000
+ effective_time: str, optional
1001
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
1044
1002
  start_from : int, optional
1045
1003
  The index from which to start fetching the engine actions. Default is 0.
1046
-
1047
-
1048
1004
  page_size : int, optional
1049
1005
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
1050
1006
 
@@ -1063,7 +1019,7 @@ class RuntimeManager(Client):
1063
1019
  loop = asyncio.get_event_loop()
1064
1020
  response = loop.run_until_complete(
1065
1021
  self._async_get_servers_by_dep_impl_type(
1066
- filter, view_server, effective_time, start_from, page_size
1022
+ filter, effective_time, start_from, page_size
1067
1023
  )
1068
1024
  )
1069
1025
  return response
@@ -1071,7 +1027,6 @@ class RuntimeManager(Client):
1071
1027
  async def _async_get_server_templates_by_dep_impl_type(
1072
1028
  self,
1073
1029
  filter: str = "*",
1074
- view_server: str = None,
1075
1030
  effective_time: str = None,
1076
1031
  start_from: int = 0,
1077
1032
  page_size: int = max_paging_size,
@@ -1085,15 +1040,10 @@ class RuntimeManager(Client):
1085
1040
  filter : str, opt
1086
1041
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
1087
1042
  If the value is None, we will default to the "OMAG Server Platform".
1088
-
1089
- view_server : str, optional
1090
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1091
- will be used.
1092
-
1043
+ effective_time: str, optional
1044
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
1093
1045
  start_from : int, optional
1094
1046
  The index from which to start fetching the engine actions. Default is 0.
1095
-
1096
-
1097
1047
  page_size : int, optional
1098
1048
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
1099
1049
 
@@ -1109,14 +1059,12 @@ class RuntimeManager(Client):
1109
1059
  UserNotAuthorizedException
1110
1060
 
1111
1061
  """
1112
- if view_server is None:
1113
- view_server = self.view_server
1114
1062
 
1115
1063
  if filter == "*":
1116
1064
  filter = None
1117
1065
 
1118
1066
  url = (
1119
- f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/"
1067
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/software-servers/"
1120
1068
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}&getTemplates=true"
1121
1069
  )
1122
1070
 
@@ -1129,7 +1077,6 @@ class RuntimeManager(Client):
1129
1077
  def get_server_templates_by_dep_impl_type(
1130
1078
  self,
1131
1079
  filter: str = "*",
1132
- view_server: str = None,
1133
1080
  effective_time: str = None,
1134
1081
  start_from: int = 0,
1135
1082
  page_size: int = max_paging_size,
@@ -1143,15 +1090,10 @@ class RuntimeManager(Client):
1143
1090
  filter : str, opt
1144
1091
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
1145
1092
  If the value is None, we will default to the "OMAG Server Platform".
1146
-
1147
- view_server : str, optional
1148
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1149
- will be used.
1150
-
1093
+ effective_time: str, optional
1094
+ Timeframe to return information for. Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601).
1151
1095
  start_from : int, optional
1152
1096
  The index from which to start fetching the engine actions. Default is 0.
1153
-
1154
-
1155
1097
  page_size : int, optional
1156
1098
  The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
1157
1099
 
@@ -1170,102 +1112,12 @@ class RuntimeManager(Client):
1170
1112
  loop = asyncio.get_event_loop()
1171
1113
  response = loop.run_until_complete(
1172
1114
  self._async_get_server_templates_by_dep_impl_type(
1173
- filter, view_server, effective_time, start_from, page_size
1115
+ filter, effective_time, start_from, page_size
1174
1116
  )
1175
1117
  )
1176
1118
  return response
1177
1119
 
1178
- async def _async_get_server_by_guid(
1179
- self,
1180
- server_guid: str = None,
1181
- view_server: str = None,
1182
- effective_time: str = None,
1183
- ) -> str | list:
1184
- """Returns details about the server's catalog entry (asset). Async version.
1185
-
1186
- Parameters
1187
- ----------
1188
- filter : str, opt
1189
- Filter specifies the kind of deployed implementation type of the platforms to return information for.
1190
- If the value is None, we will default to the "OMAG Server Platform".
1191
-
1192
- view_server : str, optional
1193
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1194
- will be used.
1195
-
1196
- start_from : int, optional
1197
- The index from which to start fetching the engine actions. Default is 0.
1198
-
1199
-
1200
- page_size : int, optional
1201
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
1202
-
1203
- Returns
1204
- -------
1205
- Response
1206
- A lit of json dict with the platform reports.
1207
-
1208
- Raises
1209
- ------
1210
- InvalidParameterException
1211
- PropertyServerException
1212
- UserNotAuthorizedException
1213
-
1214
- """
1215
- if view_server is None:
1216
- view_server = self.view_server
1217
-
1218
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
1219
-
1220
- if effective_time is not None:
1221
- body = {"effectiveTime": effective_time}
1222
- response = await self._async_make_request("POST", url, body)
1223
-
1224
- else:
1225
- response = await self._async_make_request("POST", url)
1226
-
1227
- return response.json().get("element", "No servers found")
1228
-
1229
- def get_server_by_guid(
1230
- self,
1231
- server_guid: str = None,
1232
- view_server: str = None,
1233
- effective_time: str = None,
1234
- ) -> str | list:
1235
- """Returns details about the server's catalog entry (asset). Async version.
1236
-
1237
- Parameters
1238
- ----------
1239
- filter : str, opt
1240
- Filter specifies the kind of deployed implementation type of the platforms to return information for.
1241
- If the value is None, we will default to the "OMAG Server Platform".
1242
-
1243
- view_server : str, optional
1244
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1245
- will be used.
1246
-
1247
- start_from : int, optional
1248
- The index from which to start fetching the engine actions. Default is 0.
1249
-
1250
-
1251
- page_size : int, optional
1252
- The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
1253
-
1254
- Returns
1255
- -------
1256
- Response
1257
- A lit of json dict with the platform reports.
1258
-
1259
- """
1260
- loop = asyncio.get_event_loop()
1261
- response = loop.run_until_complete(
1262
- self._async_get_server_by_guid(server_guid, view_server, effective_time)
1263
- )
1264
- return response
1265
-
1266
- async def _async_get_server_report(
1267
- self, server_guid: str = None, view_server: str = None
1268
- ) -> str | list:
1120
+ async def _async_get_server_report(self, server_guid: str = None) -> str | list:
1269
1121
  """Returns details about the running server. Async version.
1270
1122
 
1271
1123
  Parameters
@@ -1273,11 +1125,6 @@ class RuntimeManager(Client):
1273
1125
  server_guid: str
1274
1126
  Identity of the view_server to report on.
1275
1127
 
1276
- view_server : str, optional
1277
- The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1278
- will be used.
1279
-
1280
-
1281
1128
  Returns
1282
1129
  -------
1283
1130
  Response
@@ -1290,10 +1137,8 @@ class RuntimeManager(Client):
1290
1137
  UserNotAuthorizedException
1291
1138
 
1292
1139
  """
1293
- if view_server is None:
1294
- view_server = self.view_server
1295
1140
 
1296
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}/report"
1141
+ url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}/report"
1297
1142
 
1298
1143
  response = await self._async_make_request("GET", url)
1299
1144
 
@@ -1335,7 +1180,6 @@ class RuntimeManager(Client):
1335
1180
  self,
1336
1181
  archive_file: str,
1337
1182
  server_guid: str,
1338
- view_server: str = None,
1339
1183
  time_out: int = 60,
1340
1184
  ) -> None:
1341
1185
  """Add a new open metadata archive to running OMAG Server's repository.
@@ -1351,9 +1195,6 @@ class RuntimeManager(Client):
1351
1195
  Open metadata archive file to load.
1352
1196
  server_guid: str
1353
1197
  GUID of the view_server to load the file into.
1354
- view_server : str, optional
1355
- The name of the view view_server to work with. If not provided, the default view_server name
1356
- will be used.
1357
1198
  time_out: int, optional
1358
1199
  Time out for the rest call.
1359
1200
 
@@ -1369,10 +1210,8 @@ class RuntimeManager(Client):
1369
1210
  UserNotAuthorizedException
1370
1211
 
1371
1212
  """
1372
- if view_server is None:
1373
- view_server = self.view_server
1374
1213
 
1375
- url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/omag-servers/{server_guid}/instance/load/open-metadata-archives/file"
1214
+ url = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/omag-servers/{server_guid}/instance/load/open-metadata-archives/file"
1376
1215
 
1377
1216
  await self._async_make_request(
1378
1217
  "POST-DATA", url, archive_file, time_out=time_out
@@ -1383,7 +1222,6 @@ class RuntimeManager(Client):
1383
1222
  self,
1384
1223
  archive_file: str,
1385
1224
  server_guid: str,
1386
- view_server: str = None,
1387
1225
  time_out: int = 60,
1388
1226
  ) -> None:
1389
1227
  """Add a new open metadata archive to running OMAG Server's repository.
@@ -1398,9 +1236,6 @@ class RuntimeManager(Client):
1398
1236
  Open metadata archive file to load.
1399
1237
  server_guid: str
1400
1238
  GUID of the view_server to load the file into.
1401
- view_server : str, optional
1402
- The name of the view view_server to work with. If not provided, the default view_server name
1403
- will be used.
1404
1239
 
1405
1240
  Returns
1406
1241
  -------
@@ -1417,9 +1252,7 @@ class RuntimeManager(Client):
1417
1252
 
1418
1253
  loop = asyncio.get_event_loop()
1419
1254
  loop.run_until_complete(
1420
- self._async_add_archive_file(
1421
- archive_file, server_guid, view_server, time_out
1422
- )
1255
+ self._async_add_archive_file(archive_file, server_guid, time_out)
1423
1256
  )
1424
1257
  return
1425
1258
 
@@ -1427,9 +1260,7 @@ class RuntimeManager(Client):
1427
1260
  # Activate
1428
1261
  #
1429
1262
 
1430
- async def _async_activate_with_stored_config(
1431
- self, server_guid: str, view_server: str = None
1432
- ) -> None:
1263
+ async def _async_activate_with_stored_config(self, server_guid: str) -> None:
1433
1264
  """Activate the Open Metadata and Governance (OMAG) view_server using the configuration document stored for this
1434
1265
  server. Async Version
1435
1266
 
@@ -1456,9 +1287,7 @@ class RuntimeManager(Client):
1456
1287
  """
1457
1288
  pass
1458
1289
 
1459
- def activate_with_stored_config(
1460
- self, server_guid: str, view_server: str = None
1461
- ) -> None:
1290
+ def activate_with_stored_config(self, server_guid: str) -> None:
1462
1291
  """Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this
1463
1292
  server. Async Version
1464
1293
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pyegeria
3
- Version: 0.8.4.17
3
+ Version: 0.8.4.18
4
4
  Summary: A python client for Egeria
5
5
  Home-page: https://github.com/odpi/egeria-python
6
6
  License: Apache 2.0
@@ -77,7 +77,7 @@ pyegeria/egeria_cat_client.py,sha256=WyxDYklm2eDpsiHLXVJi4WP5BBeXlvWWX5h5CLevdcE
77
77
  pyegeria/egeria_client.py,sha256=8rKu-ACdyBVRw2C114mleCBI4m30YCBi7dPCt5Y-ZTY,3360
78
78
  pyegeria/egeria_config_client.py,sha256=hsfJz_eDlRh0GO9YrCTcvXIC0wKMHtL22QS3j2s_o0U,1183
79
79
  pyegeria/egeria_my_client.py,sha256=VnUQHLdk-Lbzi25UfutSSfKFUs1xP6U5T_2N5EZ0PWU,1404
80
- pyegeria/egeria_tech_client.py,sha256=cKwYN9Q-p7laXcilmc7scszdb4AnhPAk0iEV8ORQHpE,2397
80
+ pyegeria/egeria_tech_client.py,sha256=x2Bxkrm8G3M1M1AVcBo_P5YCsABFJAiAQMO-c28VscQ,2440
81
81
  pyegeria/feedback_manager_omvs.py,sha256=U0wzb5kU24vaMqhGinZ2Z5UJkhqEylhXWnnHeaS-yDU,162098
82
82
  pyegeria/full_omag_server_config.py,sha256=UNEhJS-sSLyCHJOyQ_YhfHCCxXqHjA8r8im8i-rXyp8,47012
83
83
  pyegeria/glossary_browser_omvs.py,sha256=PUdZHEc-OKO9z1mBSEb5J0RVszDhsdS6d8OciSAsOHI,103199
@@ -87,13 +87,13 @@ pyegeria/my_profile_omvs.py,sha256=eDnDK8LQIg7yrmiG8x20xMw-Yu6xuL0yXRm0vSc4T8k,4
87
87
  pyegeria/platform_services.py,sha256=hlbbG1iGuMj7JhLkz60V9xaG4m0pheYvs0bhbjF64rE,41624
88
88
  pyegeria/project_manager_omvs.py,sha256=OCdJKECI0sTZWgXcQ5TcupK5JPxHJG78-kHXyflDu1k,74521
89
89
  pyegeria/registered_info.py,sha256=3PbmqKusFX5m9KYVwbT69PIN1oSL4PhZDbbU_an7dvE,6356
90
- pyegeria/runtime_manager_omvs.py,sha256=lR8ZxzqmYmHqjFPBiv0YKQC7x5XpW4CLPPSb4M7ReXo,48377
90
+ pyegeria/runtime_manager_omvs.py,sha256=b3OR12AqxPQCFWVIiBUJZa62gOEmTqcOz2f8_sIeedc,42709
91
91
  pyegeria/server_operations.py,sha256=ciH890hYT85YQ6OpByn4w7s3a7TtvWZpIG5rkRqbcI0,16766
92
92
  pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
93
93
  pyegeria/valid_metadata_omvs.py,sha256=6Hc4g9BOS8w1ILfTG3_A1tfIX3HLtpgZZvcC-z9GePU,36185
94
94
  pyegeria/x_action_author_omvs.py,sha256=za472slZ5tN9Pkd-ukyHS5Sn6MlKkJyIlbLlU3bL_Go,6451
95
- pyegeria-0.8.4.17.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
96
- pyegeria-0.8.4.17.dist-info/METADATA,sha256=_986lIRPdXJY8eKoPhKmlI2shQ9vGLgrlcp2cQw503U,2820
97
- pyegeria-0.8.4.17.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
98
- pyegeria-0.8.4.17.dist-info/entry_points.txt,sha256=5Q9bDxIqPgdhd3lDnzdRSCYy9hZtNm_BL49bcmbBpGQ,3808
99
- pyegeria-0.8.4.17.dist-info/RECORD,,
95
+ pyegeria-0.8.4.18.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
96
+ pyegeria-0.8.4.18.dist-info/METADATA,sha256=NPLo5t9l1yD_5xWCT1m4PY0ziijVoNVMD93qGyjLkP8,2820
97
+ pyegeria-0.8.4.18.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
98
+ pyegeria-0.8.4.18.dist-info/entry_points.txt,sha256=5Q9bDxIqPgdhd3lDnzdRSCYy9hZtNm_BL49bcmbBpGQ,3808
99
+ pyegeria-0.8.4.18.dist-info/RECORD,,