pyegeria 0.8.4.12__py3-none-any.whl → 0.8.4.16__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.
@@ -18,7 +18,7 @@ class RuntimeManager(Client):
18
18
 
19
19
  Attributes:
20
20
 
21
- server_name: str
21
+ view_server : str
22
22
  Name of the server to use.
23
23
  platform_url : str
24
24
  URL of the server platform to connect to
@@ -36,23 +36,297 @@ class RuntimeManager(Client):
36
36
 
37
37
  def __init__(
38
38
  self,
39
- server_name: str,
39
+ view_server: str,
40
40
  platform_url: str,
41
41
  user_id: str,
42
42
  user_pwd: str = None,
43
43
  token: str = None,
44
44
  ):
45
- Client.__init__(self, server_name, platform_url, user_id, user_pwd, token=token)
45
+ Client.__init__(self, view_server, platform_url, user_id, user_pwd, token=token)
46
46
  self.cur_command_root = f"{platform_url}/servers/"
47
47
  self.platform_guid = "44bf319f-1e41-4da1-b771-2753b92b631a" # this is platform @ 9443 from the core content archive
48
48
  self.default_platform_name = (
49
49
  "Default Local OMAG Server Platform" # this from the core content archive
50
50
  )
51
+ self.view_server = view_server
52
+
53
+ async def _async_connect_to_cohort(
54
+ self,
55
+ server_guid: str,
56
+ cohort_name: str,
57
+ ) -> None:
58
+ """A new server needs to register the metadataCollectionId for its metadata repository with the other servers
59
+ in the open metadata repository. It only needs to do this once and uses a timestamp to record that the
60
+ registration event has been sent. If the server has already registered in the past, it sends a
61
+ reregistration request. Async version.
62
+
63
+ https://egeria-project.org/concepts/cohort-member/
64
+
65
+ Parameters
66
+ ----------
67
+ server_guid : str
68
+ Identity of the server to act on.
69
+ cohort_name : str
70
+ Name of the cohort to join
71
+
72
+ Returns
73
+ -------
74
+ None
75
+
76
+ Raises
77
+ ------
78
+ InvalidParameterException
79
+ PropertyServerException
80
+ UserNotAuthorizedException
81
+
82
+ """
83
+
84
+ url = (
85
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
86
+ f"{server_guid}/cohorts/{cohort_name}/connect"
87
+ )
88
+ await self._async_make_request("GET", url)
89
+ return
90
+
91
+ def connect_to_cohort(
92
+ self,
93
+ server_guid: str,
94
+ cohort_name: str,
95
+ ) -> None:
96
+ """A new server needs to register the metadataCollectionId for its metadata repository with the other servers
97
+ in the open metadata repository. It only needs to do this once and uses a timestamp to record that the
98
+ registration event has been sent. If the server has already registered in the past, it sends a
99
+ reregistration request.
100
+
101
+ https://egeria-project.org/concepts/cohort-member/
102
+
103
+ Parameters
104
+ ----------
105
+ server_guid: str
106
+ Identity of the server to act on.
107
+ cohort_name: str
108
+ Name of the cohort to join
109
+
110
+ Returns
111
+ -------
112
+ None
113
+
114
+ Raises
115
+ ------
116
+ InvalidParameterException
117
+ PropertyServerException
118
+ UserNotAuthorizedException
119
+
120
+ """
121
+ loop = asyncio.get_event_loop()
122
+ loop.run_until_complete(self._async_connect_to_cohort(server_guid, cohort_name))
123
+ return
124
+
125
+ async def _async_disconnect_from_cohort(
126
+ self,
127
+ server_guid: str,
128
+ cohort_name: str,
129
+ ) -> None:
130
+ """Disconnect communications from a specific cohort. Async version.
131
+ https://egeria-project.org/concepts/cohort-member/
132
+ Parameters
133
+ ----------
134
+ server_guid : str
135
+ Identity of the server to act on.
136
+ cohort_name : str
137
+ Name of the cohort to join
138
+
139
+ Returns
140
+ -------
141
+ None
142
+
143
+ Raises
144
+ ------
145
+ InvalidParameterException
146
+ PropertyServerException
147
+ UserNotAuthorizedException
148
+
149
+ """
150
+
151
+ url = (
152
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
153
+ f"{server_guid}/cohorts/{cohort_name}/disconnect"
154
+ )
155
+ await self._async_make_request("GET", url)
156
+ return
157
+
158
+ def disconnect_from_cohort(
159
+ self,
160
+ server_guid: str,
161
+ cohort_name: str,
162
+ ) -> None:
163
+ """Disconnect communications from a specific cohort.
164
+ https://egeria-project.org/concepts/cohort-member/
165
+ Parameters
166
+ ----------
167
+ server_guid: str
168
+ Identity of the server to act on.
169
+ cohort_name: str
170
+ Name of the cohort to join
171
+
172
+ Returns
173
+ -------
174
+ None
175
+
176
+ Raises
177
+ ------
178
+ InvalidParameterException
179
+ PropertyServerException
180
+ UserNotAuthorizedException
181
+
182
+ """
183
+ loop = asyncio.get_event_loop()
184
+ loop.run_until_complete(
185
+ self._async_disconnect_from_cohort(server_guid, cohort_name)
186
+ )
187
+ return
188
+
189
+ async def _async_unregister_from_cohort(
190
+ self,
191
+ server_guid: str,
192
+ cohort_name: str,
193
+ ) -> None:
194
+ """Unregister from a specific cohort and disconnect from cohort communications. Async version.
195
+ https://egeria-project.org/concepts/cohort-member/
196
+ Parameters
197
+ ----------
198
+ server_guid : str
199
+ Identity of the server to act on.
200
+ cohort_name : str
201
+ Name of the cohort to join
202
+
203
+ Returns
204
+ -------
205
+ None
206
+
207
+ Raises
208
+ ------
209
+ InvalidParameterException
210
+ PropertyServerException
211
+ UserNotAuthorizedException
212
+
213
+ """
214
+
215
+ url = (
216
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/cohort-members/"
217
+ f"{server_guid}/cohorts/{cohort_name}/unregister"
218
+ )
219
+ await self._async_make_request("GET", url)
220
+ return
221
+
222
+ def unregister_from_cohort(
223
+ self,
224
+ server_guid: str,
225
+ cohort_name: str,
226
+ ) -> None:
227
+ """Unregister from a specific cohort and disconnect from cohort communications.
228
+ https://egeria-project.org/concepts/cohort-member/
229
+
230
+ Parameters
231
+ ----------
232
+ server_guid: str
233
+ Identity of the server to act on.
234
+ cohort_name: str
235
+ Name of the cohort to join
236
+
237
+ Returns
238
+ -------
239
+ None
240
+
241
+ Raises
242
+ ------
243
+ InvalidParameterException
244
+ PropertyServerException
245
+ UserNotAuthorizedException
246
+
247
+ """
248
+ loop = asyncio.get_event_loop()
249
+ loop.run_until_complete(
250
+ self._async_disconnect_from_cohort(server_guid, cohort_name)
251
+ )
252
+ return
253
+
254
+ async def _async_refresh_config(
255
+ self,
256
+ server_guid: str,
257
+ gov_engine_name: str,
258
+ ) -> None:
259
+ """Request that the governance engine refresh its configuration by calling the metadata server. This request is
260
+ useful if the metadata server has an outage, particularly while the governance server is initializing.
261
+ This request just ensures that the latest configuration is in use. Async version.
262
+
263
+ https://egeria-project.org/concepts/governance-engine-definition/
264
+
265
+ Parameters
266
+ ----------
267
+ server_guid : str
268
+ Identity of the server to act on.
269
+ gov_engine_name : str
270
+ Name of the governance engine to refresh.
271
+
272
+ Returns
273
+ -------
274
+ None
275
+
276
+ Raises
277
+ ------
278
+ InvalidParameterException
279
+ PropertyServerException
280
+ UserNotAuthorizedException
281
+
282
+ """
283
+
284
+ url = (
285
+ f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager/engine-hosts/"
286
+ f"{server_guid}/governance_engines/{gov_engine_name}/refresh-config"
287
+ )
288
+ await self._async_make_request("GET", url)
289
+ return
290
+
291
+ def refresh_config(
292
+ self,
293
+ server_guid: str,
294
+ gov_engine_name: str,
295
+ ) -> None:
296
+ """Request that the governance engine refresh its configuration by calling the metadata server. This request is
297
+ useful if the metadata server has an outage, particularly while the governance server is initializing.
298
+ This request just ensures that the latest configuration is in use.
299
+
300
+ https://egeria-project.org/concepts/governance-engine-definition/
301
+
302
+ Parameters
303
+ ----------
304
+ server_guid : str
305
+ Identity of the server to act on.
306
+ gov_engine_name : str
307
+ Name of the governance engine to refresh.
308
+
309
+ Returns
310
+ -------
311
+ None
312
+
313
+ Raises
314
+ ------
315
+ InvalidParameterException
316
+ PropertyServerException
317
+ UserNotAuthorizedException
318
+
319
+ """
320
+ loop = asyncio.get_event_loop()
321
+ loop.run_until_complete(
322
+ self._async_refresh_config(server_guid, gov_engine_name)
323
+ )
324
+ return
51
325
 
52
326
  async def _async_get_platforms_by_name(
53
327
  self,
54
328
  filter: str = None,
55
- server: str = None,
329
+ view_server: str = None,
56
330
  effective_time: str = None,
57
331
  start_from: int = 0,
58
332
  page_size: int = max_paging_size,
@@ -64,8 +338,8 @@ class RuntimeManager(Client):
64
338
  Filter specifies the display name or qualified name of the platforms to return information for. If the
65
339
  value is None, we will default to the default_platform_name that comes from the core content pack.
66
340
 
67
- server : str, optional
68
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
69
343
  will be used.
70
344
 
71
345
  start_from : int, optional
@@ -86,14 +360,14 @@ class RuntimeManager(Client):
86
360
  UserNotAuthorizedException
87
361
 
88
362
  """
89
- if server is None:
90
- server = self.server_name
363
+ if view_server is None:
364
+ view_server = self.view_server
91
365
 
92
366
  if filter is None:
93
367
  filter = self.default_platform_name
94
368
 
95
369
  url = (
96
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/platforms/by-name?"
370
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/by-name?"
97
371
  f"startFrom={start_from}&pageSize={page_size}"
98
372
  )
99
373
  if effective_time is not None:
@@ -108,7 +382,7 @@ class RuntimeManager(Client):
108
382
  def get_platforms_by_name(
109
383
  self,
110
384
  filter: str = None,
111
- server: str = None,
385
+ view_server: str = None,
112
386
  effective_time: str = None,
113
387
  start_from: int = 0,
114
388
  page_size: int = max_paging_size,
@@ -121,8 +395,8 @@ class RuntimeManager(Client):
121
395
  Filter specifies the display name or qualified name of the platforms to return information for. If the
122
396
  value is None, we will default to the default_platform_name that comes from the core content pack.
123
397
 
124
- server : str, optional
125
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
126
400
  will be used.
127
401
 
128
402
  start_from : int, optional
@@ -146,7 +420,7 @@ class RuntimeManager(Client):
146
420
  loop = asyncio.get_event_loop()
147
421
  response = loop.run_until_complete(
148
422
  self._async_get_platforms_by_name(
149
- filter, server, effective_time, start_from, page_size
423
+ filter, view_server, effective_time, start_from, page_size
150
424
  )
151
425
  )
152
426
  return response
@@ -154,7 +428,7 @@ class RuntimeManager(Client):
154
428
  async def _async_get_platforms_by_type(
155
429
  self,
156
430
  filter: str = None,
157
- server: str = None,
431
+ view_server: str = None,
158
432
  effective_time: str = None,
159
433
  start_from: int = 0,
160
434
  page_size: int = max_paging_size,
@@ -168,8 +442,8 @@ class RuntimeManager(Client):
168
442
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
169
443
  If the value is None, we will default to the "OMAG Server Platform".
170
444
 
171
- server : str, optional
172
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
173
447
  will be used.
174
448
 
175
449
  start_from : int, optional
@@ -190,14 +464,14 @@ class RuntimeManager(Client):
190
464
  UserNotAuthorizedException
191
465
 
192
466
  """
193
- if server is None:
194
- server = self.server_name
467
+ if view_server is None:
468
+ view_server = self.view_server
195
469
 
196
470
  if filter is None:
197
471
  filter = "OMAG Server Platform"
198
472
 
199
473
  url = (
200
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/platforms/"
474
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/"
201
475
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}"
202
476
  )
203
477
 
@@ -212,7 +486,7 @@ class RuntimeManager(Client):
212
486
  def get_platforms_by_type(
213
487
  self,
214
488
  filter: str = None,
215
- server: str = None,
489
+ view_server: str = None,
216
490
  effective_time: str = None,
217
491
  start_from: int = 0,
218
492
  page_size: int = max_paging_size,
@@ -226,8 +500,8 @@ class RuntimeManager(Client):
226
500
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
227
501
  If the value is None, we will default to the "OMAG Server Platform".
228
502
 
229
- server : str, optional
230
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
231
505
  will be used.
232
506
 
233
507
  start_from : int, optional
@@ -252,7 +526,7 @@ class RuntimeManager(Client):
252
526
  loop = asyncio.get_event_loop()
253
527
  response = loop.run_until_complete(
254
528
  self._async_get_platforms_by_type(
255
- filter, server, effective_time, start_from, page_size
529
+ filter, view_server, effective_time, start_from, page_size
256
530
  )
257
531
  )
258
532
  return response
@@ -260,7 +534,7 @@ class RuntimeManager(Client):
260
534
  async def _async_get_platform_templates_by_type(
261
535
  self,
262
536
  filter: str = None,
263
- server: str = None,
537
+ view_server: str = None,
264
538
  effective_time: str = None,
265
539
  start_from: int = 0,
266
540
  page_size: int = max_paging_size,
@@ -275,8 +549,8 @@ class RuntimeManager(Client):
275
549
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
276
550
  If the value is None, we will default to the "OMAG Server Platform".
277
551
 
278
- server : str, optional
279
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
280
554
  will be used.
281
555
 
282
556
  start_from : int, optional
@@ -297,14 +571,14 @@ class RuntimeManager(Client):
297
571
  UserNotAuthorizedException
298
572
 
299
573
  """
300
- if server is None:
301
- server = self.server_name
574
+ if view_server is None:
575
+ view_server = self.view_server
302
576
 
303
577
  if filter is None:
304
578
  filter = "OMAG Server Platform"
305
579
 
306
580
  url = (
307
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/platforms/"
581
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/"
308
582
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}&getTemplates=true"
309
583
  )
310
584
 
@@ -319,7 +593,7 @@ class RuntimeManager(Client):
319
593
  def get_platform_templates_by_type(
320
594
  self,
321
595
  filter: str = None,
322
- server: str = None,
596
+ view_server: str = None,
323
597
  effective_time: str = None,
324
598
  start_from: int = 0,
325
599
  page_size: int = max_paging_size,
@@ -333,8 +607,8 @@ class RuntimeManager(Client):
333
607
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
334
608
  If the value is None, we will default to the "OMAG Server Platform".
335
609
 
336
- server : str, optional
337
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
338
612
  will be used.
339
613
 
340
614
  start_from : int, optional
@@ -359,13 +633,13 @@ class RuntimeManager(Client):
359
633
  loop = asyncio.get_event_loop()
360
634
  response = loop.run_until_complete(
361
635
  self._async_get_platforms_by_type(
362
- filter, server, effective_time, start_from, page_size
636
+ filter, view_server, effective_time, start_from, page_size
363
637
  )
364
638
  )
365
639
  return response
366
640
 
367
641
  async def _async_get_platform_report(
368
- self, platform_guid: str = None, server: str = None
642
+ self, platform_guid: str = None, view_server: str = None
369
643
  ) -> str | list:
370
644
  """Returns details about the running platform. Async version.
371
645
 
@@ -374,8 +648,8 @@ class RuntimeManager(Client):
374
648
  platform_guid : str
375
649
  The unique identifier for the platform.
376
650
 
377
- server : str, optional
378
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
379
653
  will be used.
380
654
 
381
655
  Returns
@@ -390,17 +664,17 @@ class RuntimeManager(Client):
390
664
  UserNotAuthorizedException
391
665
 
392
666
  """
393
- if server is None:
394
- server = self.server_name
667
+ if view_server is None:
668
+ view_server = self.view_server
395
669
 
396
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/platforms/{platform_guid}/report"
670
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}/report"
397
671
 
398
672
  response = await self._async_make_request("GET", url)
399
673
 
400
674
  return response.json().get("element", "No platforms found")
401
675
 
402
676
  def get_platform_report(
403
- self, platform_guid: str = None, server: str = None
677
+ self, platform_guid: str = None, view_server: str = None
404
678
  ) -> str | list:
405
679
  """Returns details about the running platform.
406
680
 
@@ -409,8 +683,8 @@ class RuntimeManager(Client):
409
683
  platform_guid : str
410
684
  The unique identifier for the platform.
411
685
 
412
- server : str, optional
413
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
414
688
  will be used.
415
689
 
416
690
 
@@ -428,12 +702,15 @@ class RuntimeManager(Client):
428
702
  """
429
703
  loop = asyncio.get_event_loop()
430
704
  response = loop.run_until_complete(
431
- self._async_get_platform_report(platform_guid, server)
705
+ self._async_get_platform_report(platform_guid, view_server)
432
706
  )
433
707
  return response
434
708
 
435
709
  async def _async_get_platform_by_guid(
436
- self, platform_guid: str = None, server: str = None, effective_time: str = None
710
+ self,
711
+ platform_guid: str = None,
712
+ view_server: str = None,
713
+ effective_time: str = None,
437
714
  ) -> str | list:
438
715
  """Returns details about the platform's catalog entry (asset). Async version.
439
716
 
@@ -443,8 +720,8 @@ class RuntimeManager(Client):
443
720
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
444
721
  If the value is None, we will default to the "OMAG Server Platform".
445
722
 
446
- server : str, optional
447
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
448
725
  will be used.
449
726
 
450
727
  start_from : int, optional
@@ -460,10 +737,10 @@ class RuntimeManager(Client):
460
737
  A lit of json dict with the platform reports.
461
738
 
462
739
  """
463
- if server is None:
464
- server = self.server_name
740
+ if view_server is None:
741
+ view_server = self.view_server
465
742
 
466
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/platforms/{platform_guid}"
743
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/platforms/{platform_guid}"
467
744
 
468
745
  if effective_time is not None:
469
746
  body = {"effectiveTime": effective_time}
@@ -475,7 +752,10 @@ class RuntimeManager(Client):
475
752
  return response.json().get("elements", "No platforms found")
476
753
 
477
754
  def get_platform_by_guid(
478
- self, platform_guid: str = None, server: str = None, effective_time: str = None
755
+ self,
756
+ platform_guid: str = None,
757
+ view_server: str = None,
758
+ effective_time: str = None,
479
759
  ) -> str | list:
480
760
  """Returns details about the platform's catalog entry (asset).
481
761
 
@@ -485,8 +765,8 @@ class RuntimeManager(Client):
485
765
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
486
766
  If the value is None, we will default to the "OMAG Server Platform".
487
767
 
488
- server : str, optional
489
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
490
770
  will be used.
491
771
 
492
772
  start_from : int, optional
@@ -510,12 +790,14 @@ class RuntimeManager(Client):
510
790
  """
511
791
  loop = asyncio.get_event_loop()
512
792
  response = loop.run_until_complete(
513
- self._async_get_platforms_by_guid(platform_guid, server, effective_time)
793
+ self._async_get_platforms_by_guid(
794
+ platform_guid, view_server, effective_time
795
+ )
514
796
  )
515
797
  return response
516
798
 
517
799
  async def _async_get_server_by_guid(
518
- self, server_guid: str, server: str = None, effective_time: str = None
800
+ self, server_guid: str, view_server: str = None, effective_time: str = None
519
801
  ) -> str | dict:
520
802
  """Returns details about the server's catalog entry (asset). Async version.
521
803
 
@@ -524,8 +806,8 @@ class RuntimeManager(Client):
524
806
  server_guid : str
525
807
  The unique identifier for the platform.
526
808
 
527
- server : str, optional
528
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
529
811
  will be used.
530
812
 
531
813
  Returns
@@ -540,10 +822,10 @@ class RuntimeManager(Client):
540
822
  UserNotAuthorizedException
541
823
 
542
824
  """
543
- if server is None:
544
- server = self.server_name
825
+ if view_server is None:
826
+ view_server = self.view_server
545
827
 
546
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
828
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
547
829
 
548
830
  if effective_time is not None:
549
831
  body = {"effectiveTime": effective_time}
@@ -552,10 +834,10 @@ class RuntimeManager(Client):
552
834
  else:
553
835
  response = await self._async_make_request("POST", url)
554
836
 
555
- return response.json().get("elements", "No server found")
837
+ return response.json().get("elements", "No view_server found")
556
838
 
557
839
  def get_server_by_guid(
558
- self, server_guid: str, server: str = None, effective_time: str = None
840
+ self, server_guid: str, view_server: str = None, effective_time: str = None
559
841
  ) -> str | dict:
560
842
  """Returns details about the platform's catalog entry (asset).
561
843
 
@@ -564,8 +846,8 @@ class RuntimeManager(Client):
564
846
  server_guid : str
565
847
  The unique identifier for the platform.
566
848
 
567
- server : str, optional
568
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
569
851
  will be used.
570
852
 
571
853
  Returns
@@ -582,14 +864,14 @@ class RuntimeManager(Client):
582
864
  """
583
865
  loop = asyncio.get_event_loop()
584
866
  response = loop.run_until_complete(
585
- self._async_get_server_by_guid(server_guid, server, effective_time)
867
+ self._async_get_server_by_guid(server_guid, view_server, effective_time)
586
868
  )
587
869
  return response
588
870
 
589
871
  async def _async_get_servers_by_name(
590
872
  self,
591
873
  filter: str,
592
- server: str = None,
874
+ view_server: str = None,
593
875
  effective_time: str = None,
594
876
  start_from: int = 0,
595
877
  page_size: int = max_paging_size,
@@ -602,8 +884,8 @@ class RuntimeManager(Client):
602
884
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
603
885
  If the value is None, we will default to the "OMAG Server Platform".
604
886
 
605
- server : str, optional
606
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
607
889
  will be used.
608
890
 
609
891
  start_from : int, optional
@@ -625,11 +907,11 @@ class RuntimeManager(Client):
625
907
  UserNotAuthorizedException
626
908
 
627
909
  """
628
- if server is None:
629
- server = self.server_name
910
+ if view_server is None:
911
+ view_server = self.view_server
630
912
 
631
913
  url = (
632
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/by-name?"
914
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/by-name?"
633
915
  f"startFrom={start_from}&pageSize={page_size}"
634
916
  )
635
917
 
@@ -641,7 +923,7 @@ class RuntimeManager(Client):
641
923
 
642
924
  return response.json().get("elements", "No platforms found")
643
925
 
644
- def get_servers_by_name(self, filter: str, server: str = None) -> str | list:
926
+ def get_servers_by_name(self, filter: str, view_server: str = None) -> str | list:
645
927
  """Returns the list of servers with a particular name. The name is specified in the filter.
646
928
 
647
929
  Parameters
@@ -650,8 +932,8 @@ class RuntimeManager(Client):
650
932
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
651
933
  If the value is None, we will default to the "OMAG Server Platform".
652
934
 
653
- server : str, optional
654
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
655
937
  will be used.
656
938
 
657
939
  start_from : int, optional
@@ -675,14 +957,14 @@ class RuntimeManager(Client):
675
957
  """
676
958
  loop = asyncio.get_event_loop()
677
959
  response = loop.run_until_complete(
678
- self._async_get_servers_by_name(filter, server)
960
+ self._async_get_servers_by_name(filter, view_server)
679
961
  )
680
962
  return response
681
963
 
682
964
  async def _async_get_servers_by_dep_impl_type(
683
965
  self,
684
966
  filter: str = "*",
685
- server: str = None,
967
+ view_server: str = None,
686
968
  effective_time: str = None,
687
969
  start_from: int = 0,
688
970
  page_size: int = max_paging_size,
@@ -697,8 +979,8 @@ class RuntimeManager(Client):
697
979
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
698
980
  If the value is None, we will default to the "OMAG Server Platform".
699
981
 
700
- server : str, optional
701
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
702
984
  will be used.
703
985
 
704
986
  start_from : int, optional
@@ -720,14 +1002,14 @@ class RuntimeManager(Client):
720
1002
  UserNotAuthorizedException
721
1003
 
722
1004
  """
723
- if server is None:
724
- server = self.server_name
1005
+ if view_server is None:
1006
+ view_server = self.view_server
725
1007
 
726
1008
  if filter == "*":
727
1009
  filter = None
728
1010
 
729
1011
  url = (
730
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/"
1012
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/"
731
1013
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}"
732
1014
  )
733
1015
 
@@ -740,7 +1022,7 @@ class RuntimeManager(Client):
740
1022
  def get_servers_by_dep_impl_type(
741
1023
  self,
742
1024
  filter: str = "*",
743
- server: str = None,
1025
+ view_server: str = None,
744
1026
  effective_time: str = None,
745
1027
  start_from: int = 0,
746
1028
  page_size: int = max_paging_size,
@@ -755,8 +1037,8 @@ class RuntimeManager(Client):
755
1037
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
756
1038
  If the value is None, we will default to the "OMAG Server Platform".
757
1039
 
758
- server : str, optional
759
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
760
1042
  will be used.
761
1043
 
762
1044
  start_from : int, optional
@@ -781,7 +1063,7 @@ class RuntimeManager(Client):
781
1063
  loop = asyncio.get_event_loop()
782
1064
  response = loop.run_until_complete(
783
1065
  self._async_get_servers_by_dep_impl_type(
784
- filter, server, effective_time, start_from, page_size
1066
+ filter, view_server, effective_time, start_from, page_size
785
1067
  )
786
1068
  )
787
1069
  return response
@@ -789,12 +1071,12 @@ class RuntimeManager(Client):
789
1071
  async def _async_get_server_templates_by_dep_impl_type(
790
1072
  self,
791
1073
  filter: str = "*",
792
- server: str = None,
1074
+ view_server: str = None,
793
1075
  effective_time: str = None,
794
1076
  start_from: int = 0,
795
1077
  page_size: int = max_paging_size,
796
1078
  ) -> str | list:
797
- """Returns the list of server templates with a particular deployed implementation type. The value is
1079
+ """Returns the list of view_server templates with a particular deployed implementation type. The value is
798
1080
  specified in the filter. If it is null, or no request body is supplied, all servers are returned.
799
1081
  Async version.
800
1082
 
@@ -804,8 +1086,8 @@ class RuntimeManager(Client):
804
1086
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
805
1087
  If the value is None, we will default to the "OMAG Server Platform".
806
1088
 
807
- server : str, optional
808
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
809
1091
  will be used.
810
1092
 
811
1093
  start_from : int, optional
@@ -827,14 +1109,14 @@ class RuntimeManager(Client):
827
1109
  UserNotAuthorizedException
828
1110
 
829
1111
  """
830
- if server is None:
831
- server = self.server_name
1112
+ if view_server is None:
1113
+ view_server = self.view_server
832
1114
 
833
1115
  if filter == "*":
834
1116
  filter = None
835
1117
 
836
1118
  url = (
837
- f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/"
1119
+ f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/"
838
1120
  f"by-deployed-implementation-type?startFrom={start_from}&pageSize={page_size}&getTemplates=true"
839
1121
  )
840
1122
 
@@ -847,12 +1129,12 @@ class RuntimeManager(Client):
847
1129
  def get_server_templates_by_dep_impl_type(
848
1130
  self,
849
1131
  filter: str = "*",
850
- server: str = None,
1132
+ view_server: str = None,
851
1133
  effective_time: str = None,
852
1134
  start_from: int = 0,
853
1135
  page_size: int = max_paging_size,
854
1136
  ) -> str | list:
855
- """Returns the list of server templates with a particular deployed implementation type.
1137
+ """Returns the list of view_server templates with a particular deployed implementation type.
856
1138
  The value is specified in the filter. If it is null, or no request body is supplied,
857
1139
  all servers are returned.
858
1140
 
@@ -862,8 +1144,8 @@ class RuntimeManager(Client):
862
1144
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
863
1145
  If the value is None, we will default to the "OMAG Server Platform".
864
1146
 
865
- server : str, optional
866
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
867
1149
  will be used.
868
1150
 
869
1151
  start_from : int, optional
@@ -888,13 +1170,16 @@ class RuntimeManager(Client):
888
1170
  loop = asyncio.get_event_loop()
889
1171
  response = loop.run_until_complete(
890
1172
  self._async_get_server_templates_by_dep_impl_type(
891
- filter, server, effective_time, start_from, page_size
1173
+ filter, view_server, effective_time, start_from, page_size
892
1174
  )
893
1175
  )
894
1176
  return response
895
1177
 
896
1178
  async def _async_get_server_by_guid(
897
- self, server_guid: str = None, server: str = None, effective_time: str = None
1179
+ self,
1180
+ server_guid: str = None,
1181
+ view_server: str = None,
1182
+ effective_time: str = None,
898
1183
  ) -> str | list:
899
1184
  """Returns details about the server's catalog entry (asset). Async version.
900
1185
 
@@ -904,8 +1189,8 @@ class RuntimeManager(Client):
904
1189
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
905
1190
  If the value is None, we will default to the "OMAG Server Platform".
906
1191
 
907
- server : str, optional
908
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
909
1194
  will be used.
910
1195
 
911
1196
  start_from : int, optional
@@ -927,10 +1212,10 @@ class RuntimeManager(Client):
927
1212
  UserNotAuthorizedException
928
1213
 
929
1214
  """
930
- if server is None:
931
- server = self.server_name
1215
+ if view_server is None:
1216
+ view_server = self.view_server
932
1217
 
933
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
1218
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}"
934
1219
 
935
1220
  if effective_time is not None:
936
1221
  body = {"effectiveTime": effective_time}
@@ -942,7 +1227,10 @@ class RuntimeManager(Client):
942
1227
  return response.json().get("element", "No servers found")
943
1228
 
944
1229
  def get_server_by_guid(
945
- self, server_guid: str = None, server: str = None, effective_time: str = None
1230
+ self,
1231
+ server_guid: str = None,
1232
+ view_server: str = None,
1233
+ effective_time: str = None,
946
1234
  ) -> str | list:
947
1235
  """Returns details about the server's catalog entry (asset). Async version.
948
1236
 
@@ -952,8 +1240,8 @@ class RuntimeManager(Client):
952
1240
  Filter specifies the kind of deployed implementation type of the platforms to return information for.
953
1241
  If the value is None, we will default to the "OMAG Server Platform".
954
1242
 
955
- server : str, optional
956
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
957
1245
  will be used.
958
1246
 
959
1247
  start_from : int, optional
@@ -971,22 +1259,22 @@ class RuntimeManager(Client):
971
1259
  """
972
1260
  loop = asyncio.get_event_loop()
973
1261
  response = loop.run_until_complete(
974
- self._async_get_server_by_guid(server_guid, server, effective_time)
1262
+ self._async_get_server_by_guid(server_guid, view_server, effective_time)
975
1263
  )
976
1264
  return response
977
1265
 
978
1266
  async def _async_get_server_report(
979
- self, server_guid: str = None, server: str = None
1267
+ self, server_guid: str = None, view_server: str = None
980
1268
  ) -> str | list:
981
1269
  """Returns details about the running server. Async version.
982
1270
 
983
1271
  Parameters
984
1272
  ----------
985
1273
  server_guid: str
986
- Identity of the server to report on.
1274
+ Identity of the view_server to report on.
987
1275
 
988
- server : str, optional
989
- The name of the server to get governance engine summaries from. If not provided, the default server name
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
990
1278
  will be used.
991
1279
 
992
1280
 
@@ -1002,27 +1290,27 @@ class RuntimeManager(Client):
1002
1290
  UserNotAuthorizedException
1003
1291
 
1004
1292
  """
1005
- if server is None:
1006
- server = self.server_name
1293
+ if view_server is None:
1294
+ view_server = self.view_server
1007
1295
 
1008
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/software-servers/{server_guid}/report"
1296
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/software-servers/{server_guid}/report"
1009
1297
 
1010
1298
  response = await self._async_make_request("GET", url)
1011
1299
 
1012
- return response.json().get("elements", "No server found")
1300
+ return response.json().get("elements", "No view_server found")
1013
1301
 
1014
1302
  def get_server_report(
1015
- self, server_guid: str = None, server: str = None
1303
+ self, server_guid: str = None, view_server: str = None
1016
1304
  ) -> str | list:
1017
1305
  """Returns details about the running server.
1018
1306
 
1019
1307
  Parameters
1020
1308
  ----------
1021
1309
  server_guid: str
1022
- Identity of the server to report on.
1310
+ Identity of the view_server to report on.
1023
1311
 
1024
- server : str, optional
1025
- The name of the server to get governance engine summaries from. If not provided, the default server name
1312
+ view_server : str, optional
1313
+ The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1026
1314
  will be used.
1027
1315
 
1028
1316
  Returns
@@ -1039,7 +1327,7 @@ class RuntimeManager(Client):
1039
1327
  """
1040
1328
  loop = asyncio.get_event_loop()
1041
1329
  response = loop.run_until_complete(
1042
- self._async_get_server_report(server_guid, server)
1330
+ self._async_get_server_report(server_guid, view_server)
1043
1331
  )
1044
1332
  return response
1045
1333
 
@@ -1062,9 +1350,9 @@ class RuntimeManager(Client):
1062
1350
  archive_file: str
1063
1351
  Open metadata archive file to load.
1064
1352
  server_guid: str
1065
- GUID of the server to load the file into.
1066
- server : str, optional
1067
- The name of the view server to work with. If not provided, the default server name
1353
+ 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
1068
1356
  will be used.
1069
1357
  time_out: int, optional
1070
1358
  Time out for the rest call.
@@ -1082,9 +1370,9 @@ class RuntimeManager(Client):
1082
1370
 
1083
1371
  """
1084
1372
  if view_server is None:
1085
- server = self.server_name
1373
+ view_server = self.view_server
1086
1374
 
1087
- url = f"{self.platform_url}/servers/{server}/api/open-metadata/runtime-manager/omag-servers/{server_guid}/instance/load/open-metadata-archives/file"
1375
+ url = f"{self.platform_url}/servers/{view_server}/api/open-metadata/runtime-manager/omag-servers/{server_guid}/instance/load/open-metadata-archives/file"
1088
1376
 
1089
1377
  await self._async_make_request(
1090
1378
  "POST-DATA", url, archive_file, time_out=time_out
@@ -1109,9 +1397,9 @@ class RuntimeManager(Client):
1109
1397
  archive_file: str
1110
1398
  Open metadata archive file to load.
1111
1399
  server_guid: str
1112
- GUID of the server to load the file into.
1113
- server : str, optional
1114
- The name of the view server to work with. If not provided, the default server name
1400
+ 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
1115
1403
  will be used.
1116
1404
 
1117
1405
  Returns
@@ -1140,18 +1428,18 @@ class RuntimeManager(Client):
1140
1428
  #
1141
1429
 
1142
1430
  async def _async_activate_with_stored_config(
1143
- self, server_guid: str, server: str = None
1431
+ self, server_guid: str, view_server: str = None
1144
1432
  ) -> None:
1145
- """Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this
1433
+ """Activate the Open Metadata and Governance (OMAG) view_server using the configuration document stored for this
1146
1434
  server. Async Version
1147
1435
 
1148
1436
  Parameters
1149
1437
  ----------
1150
1438
  server_guid: str
1151
- Identity of the server to activate.
1439
+ Identity of the view_server to activate.
1152
1440
 
1153
- server : str, optional
1154
- The name of the server to get governance engine summaries from. If not provided, the default server name
1441
+ view_server : str, optional
1442
+ The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1155
1443
  will be used.
1156
1444
 
1157
1445
  Returns
@@ -1168,7 +1456,9 @@ class RuntimeManager(Client):
1168
1456
  """
1169
1457
  pass
1170
1458
 
1171
- def activate_with_stored_config(self, server_guid: str, server: str = None) -> None:
1459
+ def activate_with_stored_config(
1460
+ self, server_guid: str, view_server: str = None
1461
+ ) -> None:
1172
1462
  """Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this
1173
1463
  server. Async Version
1174
1464
 
@@ -1177,8 +1467,8 @@ class RuntimeManager(Client):
1177
1467
  server_guid: str
1178
1468
  Identity of the server to activate.
1179
1469
 
1180
- server : str, optional
1181
- The name of the server to get governance engine summaries from. If not provided, the default server name
1470
+ view_server : str, optional
1471
+ The name of the view_server to get governance engine summaries from. If not provided, the default view_server name
1182
1472
  will be used.
1183
1473
 
1184
1474
  Returns