nominal-api 0.610.0__tar.gz → 0.612.0__tar.gz

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.

Potentially problematic release.


This version of nominal-api might be problematic. Click here for more details.

Files changed (82) hide show
  1. {nominal_api-0.610.0 → nominal_api-0.612.0}/PKG-INFO +1 -1
  2. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/__init__.py +1 -1
  3. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/_impl.py +93 -272
  4. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_catalog/__init__.py +0 -6
  5. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api.egg-info/PKG-INFO +1 -1
  6. {nominal_api-0.610.0 → nominal_api-0.612.0}/setup.py +1 -1
  7. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/api/__init__.py +0 -0
  8. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/api_ids/__init__.py +0 -0
  9. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/api_rids/__init__.py +0 -0
  10. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/attachments_api/__init__.py +0 -0
  11. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/authentication_api/__init__.py +0 -0
  12. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/authorization/__init__.py +0 -0
  13. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/comments_api/__init__.py +0 -0
  14. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/connect_download/__init__.py +0 -0
  15. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/datasource/__init__.py +0 -0
  16. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/datasource_api/__init__.py +0 -0
  17. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/datasource_logset/__init__.py +0 -0
  18. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/datasource_logset_api/__init__.py +0 -0
  19. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/datasource_pagination_api/__init__.py +0 -0
  20. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/event/__init__.py +0 -0
  21. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/ingest_api/__init__.py +0 -0
  22. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/persistent_compute_api/__init__.py +0 -0
  23. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/py.typed +0 -0
  24. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout/__init__.py +0 -0
  25. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_api/__init__.py +0 -0
  26. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_asset_api/__init__.py +0 -0
  27. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_assets/__init__.py +0 -0
  28. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_channelvariables_api/__init__.py +0 -0
  29. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_chart_api/__init__.py +0 -0
  30. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_chartdefinition_api/__init__.py +0 -0
  31. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_checklistexecution_api/__init__.py +0 -0
  32. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_checks_api/__init__.py +0 -0
  33. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_comparisonnotebook_api/__init__.py +0 -0
  34. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_comparisonrun_api/__init__.py +0 -0
  35. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_compute_api/__init__.py +0 -0
  36. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_compute_api_deprecated/__init__.py +0 -0
  37. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_compute_representation_api/__init__.py +0 -0
  38. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_compute_resolved_api/__init__.py +0 -0
  39. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_dataexport_api/__init__.py +0 -0
  40. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_datareview_api/__init__.py +0 -0
  41. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_datasource/__init__.py +0 -0
  42. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_datasource_connection/__init__.py +0 -0
  43. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_datasource_connection_api/__init__.py +0 -0
  44. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_datasource_connection_api_influx/__init__.py +0 -0
  45. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_favorites/__init__.py +0 -0
  46. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_favorites_api/__init__.py +0 -0
  47. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_integrations_api/__init__.py +0 -0
  48. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_internal_search_api/__init__.py +0 -0
  49. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_jobs_api/__init__.py +0 -0
  50. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_layout_api/__init__.py +0 -0
  51. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_metadata/__init__.py +0 -0
  52. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_notebook_api/__init__.py +0 -0
  53. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_plotting/__init__.py +0 -0
  54. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_rids_api/__init__.py +0 -0
  55. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_run_api/__init__.py +0 -0
  56. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_template_api/__init__.py +0 -0
  57. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_units_api/__init__.py +0 -0
  58. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_versioning_api/__init__.py +0 -0
  59. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_video/__init__.py +0 -0
  60. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_video_api/__init__.py +0 -0
  61. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/scout_workbookcommon_api/__init__.py +0 -0
  62. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/secrets_api/__init__.py +0 -0
  63. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/security_api_workspace/__init__.py +0 -0
  64. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/storage_datasource_api/__init__.py +0 -0
  65. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/storage_deletion_api/__init__.py +0 -0
  66. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/storage_series_api/__init__.py +0 -0
  67. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/storage_writer_api/__init__.py +0 -0
  68. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/themes_api/__init__.py +0 -0
  69. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_archetype/__init__.py +0 -0
  70. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_archetype_api/__init__.py +0 -0
  71. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_channelmetadata/__init__.py +0 -0
  72. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_channelmetadata_api/__init__.py +0 -0
  73. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_logicalseries/__init__.py +0 -0
  74. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_logicalseries_api/__init__.py +0 -0
  75. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_seriescache/__init__.py +0 -0
  76. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/timeseries_seriescache_api/__init__.py +0 -0
  77. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api/upload_api/__init__.py +0 -0
  78. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api.egg-info/SOURCES.txt +0 -0
  79. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api.egg-info/dependency_links.txt +0 -0
  80. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api.egg-info/requires.txt +0 -0
  81. {nominal_api-0.610.0 → nominal_api-0.612.0}/nominal_api.egg-info/top_level.txt +0 -0
  82. {nominal_api-0.610.0 → nominal_api-0.612.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.610.0
3
+ Version: 0.612.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -75,5 +75,5 @@ __all__ = [
75
75
 
76
76
  __conjure_generator_version__ = "4.9.0"
77
77
 
78
- __version__ = "0.610.0"
78
+ __version__ = "0.612.0"
79
79
 
@@ -12748,6 +12748,35 @@ includes metrics for check and violation review status.
12748
12748
  _decoder = ConjureDecoder()
12749
12749
  return _decoder.decode(_response.json(), bool, self._return_none_for_unknown_union_types)
12750
12750
 
12751
+ def unarchive_run(self, auth_header: str, rid: str) -> bool:
12752
+
12753
+ _headers: Dict[str, Any] = {
12754
+ 'Accept': 'application/json',
12755
+ 'Authorization': auth_header,
12756
+ }
12757
+
12758
+ _params: Dict[str, Any] = {
12759
+ }
12760
+
12761
+ _path_params: Dict[str, Any] = {
12762
+ 'rid': rid,
12763
+ }
12764
+
12765
+ _json: Any = None
12766
+
12767
+ _path = '/scout/v1/unarchive-run/{rid}'
12768
+ _path = _path.format(**_path_params)
12769
+
12770
+ _response: Response = self._request(
12771
+ 'PUT',
12772
+ self._uri + _path,
12773
+ params=_params,
12774
+ headers=_headers,
12775
+ json=_json)
12776
+
12777
+ _decoder = ConjureDecoder()
12778
+ return _decoder.decode(_response.json(), bool, self._return_none_for_unknown_union_types)
12779
+
12751
12780
  def get_data_source_ref_name_and_type_list(self, auth_header: str, workspaces: List[str] = None) -> List["scout_run_api_RefNameAndType"]:
12752
12781
  """
12753
12782
  Returns the list of ref names that are in use across specified and authorized workspaces.
@@ -13230,6 +13259,40 @@ default, follow the UCUM convention for representation.
13230
13259
  _decoder = ConjureDecoder()
13231
13260
  return None if _response.status_code == 204 else _decoder.decode(_response.json(), OptionalTypeWrapper[scout_units_api_Unit], self._return_none_for_unknown_union_types)
13232
13261
 
13262
+ def get_batch_units(self, auth_header: str, units: List[str] = None) -> Dict[str, "scout_units_api_Unit"]:
13263
+ """
13264
+ Returns information for the unit symbols if available. If the provided symbol cannot be parsed, it will be
13265
+ omitted from the map.
13266
+ """
13267
+ units = units if units is not None else []
13268
+
13269
+ _headers: Dict[str, Any] = {
13270
+ 'Accept': 'application/json',
13271
+ 'Content-Type': 'application/json',
13272
+ 'Authorization': auth_header,
13273
+ }
13274
+
13275
+ _params: Dict[str, Any] = {
13276
+ }
13277
+
13278
+ _path_params: Dict[str, Any] = {
13279
+ }
13280
+
13281
+ _json: Any = ConjureEncoder().default(units)
13282
+
13283
+ _path = '/units/v1/units/get-batch-units'
13284
+ _path = _path.format(**_path_params)
13285
+
13286
+ _response: Response = self._request(
13287
+ 'POST',
13288
+ self._uri + _path,
13289
+ params=_params,
13290
+ headers=_headers,
13291
+ json=_json)
13292
+
13293
+ _decoder = ConjureDecoder()
13294
+ return _decoder.decode(_response.json(), Dict[scout_units_api_UnitSymbol, scout_units_api_Unit], self._return_none_for_unknown_union_types)
13295
+
13233
13296
  def get_commensurable_units(self, auth_header: str, unit: str) -> List["scout_units_api_Unit"]:
13234
13297
  """
13235
13298
  Returns the set of cataloged units that can be converted to and from the given unit.
@@ -13976,12 +14039,13 @@ class scout_asset_api_Asset(ConjureBeanType):
13976
14039
  'updated_at': ConjureFieldDefinition('updatedAt', str),
13977
14040
  'attachments': ConjureFieldDefinition('attachments', List[api_rids_AttachmentRid]),
13978
14041
  'type': ConjureFieldDefinition('type', OptionalTypeWrapper[scout_rids_api_TypeRid]),
13979
- 'is_staged': ConjureFieldDefinition('isStaged', bool)
14042
+ 'is_staged': ConjureFieldDefinition('isStaged', bool),
14043
+ 'is_archived': ConjureFieldDefinition('isArchived', bool)
13980
14044
  }
13981
14045
 
13982
- __slots__: List[str] = ['_rid', '_title', '_description', '_properties', '_labels', '_links', '_data_scopes', '_created_by', '_created_at', '_updated_at', '_attachments', '_type', '_is_staged']
14046
+ __slots__: List[str] = ['_rid', '_title', '_description', '_properties', '_labels', '_links', '_data_scopes', '_created_by', '_created_at', '_updated_at', '_attachments', '_type', '_is_staged', '_is_archived']
13983
14047
 
13984
- def __init__(self, attachments: List[str], created_at: str, data_scopes: List["scout_asset_api_AssetDataScope"], is_staged: bool, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, title: str, updated_at: str, created_by: Optional[str] = None, description: Optional[str] = None, type: Optional[str] = None) -> None:
14048
+ def __init__(self, attachments: List[str], created_at: str, data_scopes: List["scout_asset_api_AssetDataScope"], is_archived: bool, is_staged: bool, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, title: str, updated_at: str, created_by: Optional[str] = None, description: Optional[str] = None, type: Optional[str] = None) -> None:
13985
14049
  self._rid = rid
13986
14050
  self._title = title
13987
14051
  self._description = description
@@ -13995,6 +14059,7 @@ class scout_asset_api_Asset(ConjureBeanType):
13995
14059
  self._attachments = attachments
13996
14060
  self._type = type
13997
14061
  self._is_staged = is_staged
14062
+ self._is_archived = is_archived
13998
14063
 
13999
14064
  @builtins.property
14000
14065
  def rid(self) -> str:
@@ -14062,6 +14127,10 @@ To associate links with a range of time, create a time range on the asset with l
14062
14127
  """
14063
14128
  return self._is_staged
14064
14129
 
14130
+ @builtins.property
14131
+ def is_archived(self) -> bool:
14132
+ return self._is_archived
14133
+
14065
14134
 
14066
14135
  scout_asset_api_Asset.__name__ = "Asset"
14067
14136
  scout_asset_api_Asset.__qualname__ = "Asset"
@@ -16256,35 +16325,6 @@ a file, primarily CSV.
16256
16325
  _decoder = ConjureDecoder()
16257
16326
  return None if _response.status_code == 204 else _decoder.decode(_response.json(), OptionalTypeWrapper[scout_catalog_Handle], self._return_none_for_unknown_union_types)
16258
16327
 
16259
- def get_series_details(self, auth_header: str, get_series_details: "scout_catalog_GetSeriesDetailsRequest") -> "scout_catalog_SeriesDetails":
16260
-
16261
- _headers: Dict[str, Any] = {
16262
- 'Accept': 'application/json',
16263
- 'Content-Type': 'application/json',
16264
- 'Authorization': auth_header,
16265
- }
16266
-
16267
- _params: Dict[str, Any] = {
16268
- }
16269
-
16270
- _path_params: Dict[str, Any] = {
16271
- }
16272
-
16273
- _json: Any = ConjureEncoder().default(get_series_details)
16274
-
16275
- _path = '/catalog/v1/series/details'
16276
- _path = _path.format(**_path_params)
16277
-
16278
- _response: Response = self._request(
16279
- 'POST',
16280
- self._uri + _path,
16281
- params=_params,
16282
- headers=_headers,
16283
- json=_json)
16284
-
16285
- _decoder = ConjureDecoder()
16286
- return _decoder.decode(_response.json(), scout_catalog_SeriesDetails, self._return_none_for_unknown_union_types)
16287
-
16288
16328
  def create_dataset(self, auth_header: str, details: "scout_catalog_CreateDataset") -> "scout_catalog_EnrichedDataset":
16289
16329
 
16290
16330
  _headers: Dict[str, Any] = {
@@ -16596,35 +16636,6 @@ the bounds will be min(current start, request start), max(current end, request e
16596
16636
  _decoder = ConjureDecoder()
16597
16637
  return _decoder.decode(_response.json(), scout_catalog_Dataset, self._return_none_for_unknown_union_types)
16598
16638
 
16599
- def delete_dataset_series(self, auth_header: str, dataset_rid: str) -> "scout_catalog_DeleteSeriesResult":
16600
-
16601
- _headers: Dict[str, Any] = {
16602
- 'Accept': 'application/json',
16603
- 'Authorization': auth_header,
16604
- }
16605
-
16606
- _params: Dict[str, Any] = {
16607
- }
16608
-
16609
- _path_params: Dict[str, Any] = {
16610
- 'datasetRid': dataset_rid,
16611
- }
16612
-
16613
- _json: Any = None
16614
-
16615
- _path = '/catalog/v1/series/for-dataset/{datasetRid}'
16616
- _path = _path.format(**_path_params)
16617
-
16618
- _response: Response = self._request(
16619
- 'DELETE',
16620
- self._uri + _path,
16621
- params=_params,
16622
- headers=_headers,
16623
- json=_json)
16624
-
16625
- _decoder = ConjureDecoder()
16626
- return _decoder.decode(_response.json(), scout_catalog_DeleteSeriesResult, self._return_none_for_unknown_union_types)
16627
-
16628
16639
  def archive_dataset(self, auth_header: str, dataset_rid: str) -> None:
16629
16640
  """
16630
16641
  Archives a dataset, which will hide it from search results unless the includeArchived flag is set to true. The
@@ -17292,29 +17303,6 @@ scout_catalog_DatasetOriginMetadata.__qualname__ = "DatasetOriginMetadata"
17292
17303
  scout_catalog_DatasetOriginMetadata.__module__ = "nominal_api.scout_catalog"
17293
17304
 
17294
17305
 
17295
- class scout_catalog_DeleteSeriesResult(ConjureBeanType):
17296
-
17297
- @builtins.classmethod
17298
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
17299
- return {
17300
- 'number_deleted': ConjureFieldDefinition('numberDeleted', int)
17301
- }
17302
-
17303
- __slots__: List[str] = ['_number_deleted']
17304
-
17305
- def __init__(self, number_deleted: int) -> None:
17306
- self._number_deleted = number_deleted
17307
-
17308
- @builtins.property
17309
- def number_deleted(self) -> int:
17310
- return self._number_deleted
17311
-
17312
-
17313
- scout_catalog_DeleteSeriesResult.__name__ = "DeleteSeriesResult"
17314
- scout_catalog_DeleteSeriesResult.__qualname__ = "DeleteSeriesResult"
17315
- scout_catalog_DeleteSeriesResult.__module__ = "nominal_api.scout_catalog"
17316
-
17317
-
17318
17306
  class scout_catalog_EnrichedDataset(ConjureBeanType):
17319
17307
 
17320
17308
  @builtins.classmethod
@@ -17561,135 +17549,6 @@ scout_catalog_GetHandlesForDatasetsRequest.__qualname__ = "GetHandlesForDatasets
17561
17549
  scout_catalog_GetHandlesForDatasetsRequest.__module__ = "nominal_api.scout_catalog"
17562
17550
 
17563
17551
 
17564
- class scout_catalog_GetSeriesDetailsByName(ConjureBeanType):
17565
-
17566
- @builtins.classmethod
17567
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
17568
- return {
17569
- 'dataset_rid': ConjureFieldDefinition('datasetRid', str),
17570
- 'name': ConjureFieldDefinition('name', str)
17571
- }
17572
-
17573
- __slots__: List[str] = ['_dataset_rid', '_name']
17574
-
17575
- def __init__(self, dataset_rid: str, name: str) -> None:
17576
- self._dataset_rid = dataset_rid
17577
- self._name = name
17578
-
17579
- @builtins.property
17580
- def dataset_rid(self) -> str:
17581
- return self._dataset_rid
17582
-
17583
- @builtins.property
17584
- def name(self) -> str:
17585
- return self._name
17586
-
17587
-
17588
- scout_catalog_GetSeriesDetailsByName.__name__ = "GetSeriesDetailsByName"
17589
- scout_catalog_GetSeriesDetailsByName.__qualname__ = "GetSeriesDetailsByName"
17590
- scout_catalog_GetSeriesDetailsByName.__module__ = "nominal_api.scout_catalog"
17591
-
17592
-
17593
- class scout_catalog_GetSeriesDetailsByRid(ConjureBeanType):
17594
-
17595
- @builtins.classmethod
17596
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
17597
- return {
17598
- 'rid': ConjureFieldDefinition('rid', str)
17599
- }
17600
-
17601
- __slots__: List[str] = ['_rid']
17602
-
17603
- def __init__(self, rid: str) -> None:
17604
- self._rid = rid
17605
-
17606
- @builtins.property
17607
- def rid(self) -> str:
17608
- return self._rid
17609
-
17610
-
17611
- scout_catalog_GetSeriesDetailsByRid.__name__ = "GetSeriesDetailsByRid"
17612
- scout_catalog_GetSeriesDetailsByRid.__qualname__ = "GetSeriesDetailsByRid"
17613
- scout_catalog_GetSeriesDetailsByRid.__module__ = "nominal_api.scout_catalog"
17614
-
17615
-
17616
- class scout_catalog_GetSeriesDetailsRequest(ConjureUnionType):
17617
- _by_rid: Optional["scout_catalog_GetSeriesDetailsByRid"] = None
17618
- _by_name: Optional["scout_catalog_GetSeriesDetailsByName"] = None
17619
-
17620
- @builtins.classmethod
17621
- def _options(cls) -> Dict[str, ConjureFieldDefinition]:
17622
- return {
17623
- 'by_rid': ConjureFieldDefinition('byRid', scout_catalog_GetSeriesDetailsByRid),
17624
- 'by_name': ConjureFieldDefinition('byName', scout_catalog_GetSeriesDetailsByName)
17625
- }
17626
-
17627
- def __init__(
17628
- self,
17629
- by_rid: Optional["scout_catalog_GetSeriesDetailsByRid"] = None,
17630
- by_name: Optional["scout_catalog_GetSeriesDetailsByName"] = None,
17631
- type_of_union: Optional[str] = None
17632
- ) -> None:
17633
- if type_of_union is None:
17634
- if (by_rid is not None) + (by_name is not None) != 1:
17635
- raise ValueError('a union must contain a single member')
17636
-
17637
- if by_rid is not None:
17638
- self._by_rid = by_rid
17639
- self._type = 'byRid'
17640
- if by_name is not None:
17641
- self._by_name = by_name
17642
- self._type = 'byName'
17643
-
17644
- elif type_of_union == 'byRid':
17645
- if by_rid is None:
17646
- raise ValueError('a union value must not be None')
17647
- self._by_rid = by_rid
17648
- self._type = 'byRid'
17649
- elif type_of_union == 'byName':
17650
- if by_name is None:
17651
- raise ValueError('a union value must not be None')
17652
- self._by_name = by_name
17653
- self._type = 'byName'
17654
-
17655
- @builtins.property
17656
- def by_rid(self) -> Optional["scout_catalog_GetSeriesDetailsByRid"]:
17657
- return self._by_rid
17658
-
17659
- @builtins.property
17660
- def by_name(self) -> Optional["scout_catalog_GetSeriesDetailsByName"]:
17661
- return self._by_name
17662
-
17663
- def accept(self, visitor) -> Any:
17664
- if not isinstance(visitor, scout_catalog_GetSeriesDetailsRequestVisitor):
17665
- raise ValueError('{} is not an instance of scout_catalog_GetSeriesDetailsRequestVisitor'.format(visitor.__class__.__name__))
17666
- if self._type == 'byRid' and self.by_rid is not None:
17667
- return visitor._by_rid(self.by_rid)
17668
- if self._type == 'byName' and self.by_name is not None:
17669
- return visitor._by_name(self.by_name)
17670
-
17671
-
17672
- scout_catalog_GetSeriesDetailsRequest.__name__ = "GetSeriesDetailsRequest"
17673
- scout_catalog_GetSeriesDetailsRequest.__qualname__ = "GetSeriesDetailsRequest"
17674
- scout_catalog_GetSeriesDetailsRequest.__module__ = "nominal_api.scout_catalog"
17675
-
17676
-
17677
- class scout_catalog_GetSeriesDetailsRequestVisitor:
17678
-
17679
- @abstractmethod
17680
- def _by_rid(self, by_rid: "scout_catalog_GetSeriesDetailsByRid") -> Any:
17681
- pass
17682
-
17683
- @abstractmethod
17684
- def _by_name(self, by_name: "scout_catalog_GetSeriesDetailsByName") -> Any:
17685
- pass
17686
-
17687
-
17688
- scout_catalog_GetSeriesDetailsRequestVisitor.__name__ = "GetSeriesDetailsRequestVisitor"
17689
- scout_catalog_GetSeriesDetailsRequestVisitor.__qualname__ = "GetSeriesDetailsRequestVisitor"
17690
- scout_catalog_GetSeriesDetailsRequestVisitor.__module__ = "nominal_api.scout_catalog"
17691
-
17692
-
17693
17552
  class scout_catalog_Handle(ConjureUnionType):
17694
17553
  _s3: Optional["scout_catalog_S3Handle"] = None
17695
17554
 
@@ -18451,59 +18310,6 @@ scout_catalog_SearchDatasetsResponse.__qualname__ = "SearchDatasetsResponse"
18451
18310
  scout_catalog_SearchDatasetsResponse.__module__ = "nominal_api.scout_catalog"
18452
18311
 
18453
18312
 
18454
- class scout_catalog_SeriesDetails(ConjureBeanType):
18455
-
18456
- @builtins.classmethod
18457
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
18458
- return {
18459
- 'rid': ConjureFieldDefinition('rid', str),
18460
- 'name': ConjureFieldDefinition('name', str),
18461
- 'origin_metadata': ConjureFieldDefinition('originMetadata', Dict[str, str]),
18462
- 'csv_index': ConjureFieldDefinition('csvIndex', OptionalTypeWrapper[int]),
18463
- 'dataset_rid': ConjureFieldDefinition('datasetRid', str),
18464
- 'handle': ConjureFieldDefinition('handle', scout_catalog_Handle)
18465
- }
18466
-
18467
- __slots__: List[str] = ['_rid', '_name', '_origin_metadata', '_csv_index', '_dataset_rid', '_handle']
18468
-
18469
- def __init__(self, dataset_rid: str, handle: "scout_catalog_Handle", name: str, origin_metadata: Dict[str, str], rid: str, csv_index: Optional[int] = None) -> None:
18470
- self._rid = rid
18471
- self._name = name
18472
- self._origin_metadata = origin_metadata
18473
- self._csv_index = csv_index
18474
- self._dataset_rid = dataset_rid
18475
- self._handle = handle
18476
-
18477
- @builtins.property
18478
- def rid(self) -> str:
18479
- return self._rid
18480
-
18481
- @builtins.property
18482
- def name(self) -> str:
18483
- return self._name
18484
-
18485
- @builtins.property
18486
- def origin_metadata(self) -> Dict[str, str]:
18487
- return self._origin_metadata
18488
-
18489
- @builtins.property
18490
- def csv_index(self) -> Optional[int]:
18491
- return self._csv_index
18492
-
18493
- @builtins.property
18494
- def dataset_rid(self) -> str:
18495
- return self._dataset_rid
18496
-
18497
- @builtins.property
18498
- def handle(self) -> "scout_catalog_Handle":
18499
- return self._handle
18500
-
18501
-
18502
- scout_catalog_SeriesDetails.__name__ = "SeriesDetails"
18503
- scout_catalog_SeriesDetails.__qualname__ = "SeriesDetails"
18504
- scout_catalog_SeriesDetails.__module__ = "nominal_api.scout_catalog"
18505
-
18506
-
18507
18313
  class scout_catalog_SkipRowsConfig(ConjureBeanType):
18508
18314
 
18509
18315
  @builtins.classmethod
@@ -62868,12 +62674,13 @@ class scout_run_api_Run(ConjureBeanType):
62868
62674
  'data_sources': ConjureFieldDefinition('dataSources', Dict[scout_api_DataSourceRefName, scout_run_api_RunDataSource]),
62869
62675
  'attachments': ConjureFieldDefinition('attachments', List[api_rids_AttachmentRid]),
62870
62676
  'asset': ConjureFieldDefinition('asset', OptionalTypeWrapper[scout_rids_api_AssetRid]),
62871
- 'assets': ConjureFieldDefinition('assets', List[scout_rids_api_AssetRid])
62677
+ 'assets': ConjureFieldDefinition('assets', List[scout_rids_api_AssetRid]),
62678
+ 'is_archived': ConjureFieldDefinition('isArchived', bool)
62872
62679
  }
62873
62680
 
62874
- __slots__: List[str] = ['_rid', '_run_number', '_run_prefix', '_title', '_description', '_author_rid', '_start_time', '_end_time', '_properties', '_labels', '_links', '_created_at', '_updated_at', '_asset_data_scopes', '_data_sources', '_attachments', '_asset', '_assets']
62681
+ __slots__: List[str] = ['_rid', '_run_number', '_run_prefix', '_title', '_description', '_author_rid', '_start_time', '_end_time', '_properties', '_labels', '_links', '_created_at', '_updated_at', '_asset_data_scopes', '_data_sources', '_attachments', '_asset', '_assets', '_is_archived']
62875
62682
 
62876
- def __init__(self, asset_data_scopes: List["scout_asset_api_AssetDataScope"], assets: List[str], attachments: List[str], created_at: str, data_sources: Dict[str, "scout_run_api_RunDataSource"], description: str, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, run_number: int, start_time: "scout_run_api_UtcTimestamp", title: str, updated_at: str, asset: Optional[str] = None, author_rid: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, run_prefix: Optional[str] = None) -> None:
62683
+ def __init__(self, asset_data_scopes: List["scout_asset_api_AssetDataScope"], assets: List[str], attachments: List[str], created_at: str, data_sources: Dict[str, "scout_run_api_RunDataSource"], description: str, is_archived: bool, labels: List[str], links: List["scout_run_api_Link"], properties: Dict[str, str], rid: str, run_number: int, start_time: "scout_run_api_UtcTimestamp", title: str, updated_at: str, asset: Optional[str] = None, author_rid: Optional[str] = None, end_time: Optional["scout_run_api_UtcTimestamp"] = None, run_prefix: Optional[str] = None) -> None:
62877
62684
  self._rid = rid
62878
62685
  self._run_number = run_number
62879
62686
  self._run_prefix = run_prefix
@@ -62892,6 +62699,7 @@ class scout_run_api_Run(ConjureBeanType):
62892
62699
  self._attachments = attachments
62893
62700
  self._asset = asset
62894
62701
  self._assets = assets
62702
+ self._is_archived = is_archived
62895
62703
 
62896
62704
  @builtins.property
62897
62705
  def rid(self) -> str:
@@ -62968,6 +62776,10 @@ class scout_run_api_Run(ConjureBeanType):
62968
62776
  def assets(self) -> List[str]:
62969
62777
  return self._assets
62970
62778
 
62779
+ @builtins.property
62780
+ def is_archived(self) -> bool:
62781
+ return self._is_archived
62782
+
62971
62783
 
62972
62784
  scout_run_api_Run.__name__ = "Run"
62973
62785
  scout_run_api_Run.__qualname__ = "Run"
@@ -63636,16 +63448,18 @@ class scout_run_api_SearchRunsRequest(ConjureBeanType):
63636
63448
  'sort': ConjureFieldDefinition('sort', scout_run_api_SortOptions),
63637
63449
  'page_size': ConjureFieldDefinition('pageSize', int),
63638
63450
  'next_page_token': ConjureFieldDefinition('nextPageToken', OptionalTypeWrapper[api_Token]),
63639
- 'query': ConjureFieldDefinition('query', scout_run_api_SearchQuery)
63451
+ 'query': ConjureFieldDefinition('query', scout_run_api_SearchQuery),
63452
+ 'archived_statuses': ConjureFieldDefinition('archivedStatuses', OptionalTypeWrapper[List[api_ArchivedStatus]])
63640
63453
  }
63641
63454
 
63642
- __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query']
63455
+ __slots__: List[str] = ['_sort', '_page_size', '_next_page_token', '_query', '_archived_statuses']
63643
63456
 
63644
- def __init__(self, page_size: int, query: "scout_run_api_SearchQuery", sort: "scout_run_api_SortOptions", next_page_token: Optional[str] = None) -> None:
63457
+ def __init__(self, page_size: int, query: "scout_run_api_SearchQuery", sort: "scout_run_api_SortOptions", archived_statuses: Optional[List["api_ArchivedStatus"]] = None, next_page_token: Optional[str] = None) -> None:
63645
63458
  self._sort = sort
63646
63459
  self._page_size = page_size
63647
63460
  self._next_page_token = next_page_token
63648
63461
  self._query = query
63462
+ self._archived_statuses = archived_statuses
63649
63463
 
63650
63464
  @builtins.property
63651
63465
  def sort(self) -> "scout_run_api_SortOptions":
@@ -63666,6 +63480,13 @@ class scout_run_api_SearchRunsRequest(ConjureBeanType):
63666
63480
  def query(self) -> "scout_run_api_SearchQuery":
63667
63481
  return self._query
63668
63482
 
63483
+ @builtins.property
63484
+ def archived_statuses(self) -> Optional[List["api_ArchivedStatus"]]:
63485
+ """
63486
+ Default search status is NOT_ARCHIVED if none are provided. Allows for including archived runs in search.
63487
+ """
63488
+ return self._archived_statuses
63489
+
63669
63490
 
63670
63491
  scout_run_api_SearchRunsRequest.__name__ = "SearchRunsRequest"
63671
63492
  scout_run_api_SearchRunsRequest.__qualname__ = "SearchRunsRequest"
@@ -17,17 +17,12 @@ from .._impl import (
17
17
  scout_catalog_DatasetFilesPage as DatasetFilesPage,
18
18
  scout_catalog_DatasetFilter as DatasetFilter,
19
19
  scout_catalog_DatasetOriginMetadata as DatasetOriginMetadata,
20
- scout_catalog_DeleteSeriesResult as DeleteSeriesResult,
21
20
  scout_catalog_EnrichedDataset as EnrichedDataset,
22
21
  scout_catalog_EpochTimestamp as EpochTimestamp,
23
22
  scout_catalog_GetChannelsForDatasetsRequest as GetChannelsForDatasetsRequest,
24
23
  scout_catalog_GetDatasetsRequest as GetDatasetsRequest,
25
24
  scout_catalog_GetDetailsForChannelsRequest as GetDetailsForChannelsRequest,
26
25
  scout_catalog_GetHandlesForDatasetsRequest as GetHandlesForDatasetsRequest,
27
- scout_catalog_GetSeriesDetailsByName as GetSeriesDetailsByName,
28
- scout_catalog_GetSeriesDetailsByRid as GetSeriesDetailsByRid,
29
- scout_catalog_GetSeriesDetailsRequest as GetSeriesDetailsRequest,
30
- scout_catalog_GetSeriesDetailsRequestVisitor as GetSeriesDetailsRequestVisitor,
31
26
  scout_catalog_Handle as Handle,
32
27
  scout_catalog_HandleVisitor as HandleVisitor,
33
28
  scout_catalog_IngestProgressV2 as IngestProgressV2,
@@ -46,7 +41,6 @@ from .._impl import (
46
41
  scout_catalog_SearchDatasetsQueryVisitor as SearchDatasetsQueryVisitor,
47
42
  scout_catalog_SearchDatasetsRequest as SearchDatasetsRequest,
48
43
  scout_catalog_SearchDatasetsResponse as SearchDatasetsResponse,
49
- scout_catalog_SeriesDetails as SeriesDetails,
50
44
  scout_catalog_SkipRowsConfig as SkipRowsConfig,
51
45
  scout_catalog_SortField as SortField,
52
46
  scout_catalog_SortOptions as SortOptions,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.610.0
3
+ Version: 0.612.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -6,7 +6,7 @@ from setuptools import (
6
6
 
7
7
  setup(
8
8
  name='nominal-api',
9
- version='0.610.0',
9
+ version='0.612.0',
10
10
  python_requires='>=3.8',
11
11
  package_data={"": ["py.typed"]},
12
12
  packages=find_packages(),
File without changes