nominal-api 0.743.0__py3-none-any.whl → 0.745.0__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.
nominal_api/__init__.py CHANGED
@@ -77,5 +77,5 @@ __all__ = [
77
77
 
78
78
  __conjure_generator_version__ = "4.17.0"
79
79
 
80
- __version__ = "0.743.0"
80
+ __version__ = "0.745.0"
81
81
 
nominal_api/_impl.py CHANGED
@@ -21830,15 +21830,17 @@ class scout_catalog_AddFileToDataset(ConjureBeanType):
21830
21830
  return {
21831
21831
  'handle': ConjureFieldDefinition('handle', scout_catalog_Handle),
21832
21832
  'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[scout_catalog_TimestampMetadata]),
21833
+ 'ingest_tag_metadata': ConjureFieldDefinition('ingestTagMetadata', OptionalTypeWrapper[scout_catalog_IngestTagMetadata]),
21833
21834
  'origin_file_handles': ConjureFieldDefinition('originFileHandles', OptionalTypeWrapper[List[scout_catalog_S3Handle]]),
21834
21835
  'ingest_job_rid': ConjureFieldDefinition('ingestJobRid', OptionalTypeWrapper[ingest_api_IngestJobRid])
21835
21836
  }
21836
21837
 
21837
- __slots__: List[str] = ['_handle', '_timestamp_metadata', '_origin_file_handles', '_ingest_job_rid']
21838
+ __slots__: List[str] = ['_handle', '_timestamp_metadata', '_ingest_tag_metadata', '_origin_file_handles', '_ingest_job_rid']
21838
21839
 
21839
- def __init__(self, handle: "scout_catalog_Handle", ingest_job_rid: Optional[str] = None, origin_file_handles: Optional[List["scout_catalog_S3Handle"]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
21840
+ def __init__(self, handle: "scout_catalog_Handle", ingest_job_rid: Optional[str] = None, ingest_tag_metadata: Optional["scout_catalog_IngestTagMetadata"] = None, origin_file_handles: Optional[List["scout_catalog_S3Handle"]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
21840
21841
  self._handle = handle
21841
21842
  self._timestamp_metadata = timestamp_metadata
21843
+ self._ingest_tag_metadata = ingest_tag_metadata
21842
21844
  self._origin_file_handles = origin_file_handles
21843
21845
  self._ingest_job_rid = ingest_job_rid
21844
21846
 
@@ -21850,6 +21852,10 @@ class scout_catalog_AddFileToDataset(ConjureBeanType):
21850
21852
  def timestamp_metadata(self) -> Optional["scout_catalog_TimestampMetadata"]:
21851
21853
  return self._timestamp_metadata
21852
21854
 
21855
+ @builtins.property
21856
+ def ingest_tag_metadata(self) -> Optional["scout_catalog_IngestTagMetadata"]:
21857
+ return self._ingest_tag_metadata
21858
+
21853
21859
  @builtins.property
21854
21860
  def origin_file_handles(self) -> Optional[List["scout_catalog_S3Handle"]]:
21855
21861
  return self._origin_file_handles
@@ -23020,14 +23026,15 @@ class scout_catalog_DatasetFile(ConjureBeanType):
23020
23026
  'ingested_at': ConjureFieldDefinition('ingestedAt', OptionalTypeWrapper[str]),
23021
23027
  'ingest_status': ConjureFieldDefinition('ingestStatus', api_IngestStatusV2),
23022
23028
  'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[scout_catalog_TimestampMetadata]),
23029
+ 'ingest_tag_metadata': ConjureFieldDefinition('ingestTagMetadata', OptionalTypeWrapper[scout_catalog_IngestTagMetadata]),
23023
23030
  'origin_file_paths': ConjureFieldDefinition('originFilePaths', OptionalTypeWrapper[List[str]]),
23024
23031
  'ingest_job_rid': ConjureFieldDefinition('ingestJobRid', OptionalTypeWrapper[ingest_api_IngestJobRid]),
23025
23032
  'deleted_at': ConjureFieldDefinition('deletedAt', OptionalTypeWrapper[str])
23026
23033
  }
23027
23034
 
23028
- __slots__: List[str] = ['_id', '_dataset_rid', '_name', '_handle', '_bounds', '_uploaded_at', '_ingested_at', '_ingest_status', '_timestamp_metadata', '_origin_file_paths', '_ingest_job_rid', '_deleted_at']
23035
+ __slots__: List[str] = ['_id', '_dataset_rid', '_name', '_handle', '_bounds', '_uploaded_at', '_ingested_at', '_ingest_status', '_timestamp_metadata', '_ingest_tag_metadata', '_origin_file_paths', '_ingest_job_rid', '_deleted_at']
23029
23036
 
23030
- def __init__(self, dataset_rid: str, handle: "scout_catalog_Handle", id: str, ingest_status: "api_IngestStatusV2", name: str, uploaded_at: str, bounds: Optional["scout_catalog_Bounds"] = None, deleted_at: Optional[str] = None, ingest_job_rid: Optional[str] = None, ingested_at: Optional[str] = None, origin_file_paths: Optional[List[str]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
23037
+ def __init__(self, dataset_rid: str, handle: "scout_catalog_Handle", id: str, ingest_status: "api_IngestStatusV2", name: str, uploaded_at: str, bounds: Optional["scout_catalog_Bounds"] = None, deleted_at: Optional[str] = None, ingest_job_rid: Optional[str] = None, ingest_tag_metadata: Optional["scout_catalog_IngestTagMetadata"] = None, ingested_at: Optional[str] = None, origin_file_paths: Optional[List[str]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
23031
23038
  self._id = id
23032
23039
  self._dataset_rid = dataset_rid
23033
23040
  self._name = name
@@ -23037,6 +23044,7 @@ class scout_catalog_DatasetFile(ConjureBeanType):
23037
23044
  self._ingested_at = ingested_at
23038
23045
  self._ingest_status = ingest_status
23039
23046
  self._timestamp_metadata = timestamp_metadata
23047
+ self._ingest_tag_metadata = ingest_tag_metadata
23040
23048
  self._origin_file_paths = origin_file_paths
23041
23049
  self._ingest_job_rid = ingest_job_rid
23042
23050
  self._deleted_at = deleted_at
@@ -23082,6 +23090,10 @@ ingested for any reason or is still being processed, then this value will be emp
23082
23090
  def timestamp_metadata(self) -> Optional["scout_catalog_TimestampMetadata"]:
23083
23091
  return self._timestamp_metadata
23084
23092
 
23093
+ @builtins.property
23094
+ def ingest_tag_metadata(self) -> Optional["scout_catalog_IngestTagMetadata"]:
23095
+ return self._ingest_tag_metadata
23096
+
23085
23097
  @builtins.property
23086
23098
  def origin_file_paths(self) -> Optional[List[str]]:
23087
23099
  return self._origin_file_paths
@@ -23599,6 +23611,39 @@ scout_catalog_IngestStatus.__qualname__ = "IngestStatus"
23599
23611
  scout_catalog_IngestStatus.__module__ = "nominal_api.scout_catalog"
23600
23612
 
23601
23613
 
23614
+ class scout_catalog_IngestTagMetadata(ConjureBeanType):
23615
+ """The tags used when ingesting the dataset file.
23616
+ """
23617
+
23618
+ @builtins.classmethod
23619
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
23620
+ return {
23621
+ 'tag_columns': ConjureFieldDefinition('tagColumns', Dict[api_TagName, api_ColumnName]),
23622
+ 'additional_file_tags': ConjureFieldDefinition('additionalFileTags', Dict[api_TagName, api_TagValue])
23623
+ }
23624
+
23625
+ __slots__: List[str] = ['_tag_columns', '_additional_file_tags']
23626
+
23627
+ def __init__(self, additional_file_tags: Dict[str, str], tag_columns: Dict[str, str]) -> None:
23628
+ self._tag_columns = tag_columns
23629
+ self._additional_file_tags = additional_file_tags
23630
+
23631
+ @builtins.property
23632
+ def tag_columns(self) -> Dict[str, str]:
23633
+ """A map of tag names to column names to derive the tag values from.
23634
+ """
23635
+ return self._tag_columns
23636
+
23637
+ @builtins.property
23638
+ def additional_file_tags(self) -> Dict[str, str]:
23639
+ return self._additional_file_tags
23640
+
23641
+
23642
+ scout_catalog_IngestTagMetadata.__name__ = "IngestTagMetadata"
23643
+ scout_catalog_IngestTagMetadata.__qualname__ = "IngestTagMetadata"
23644
+ scout_catalog_IngestTagMetadata.__module__ = "nominal_api.scout_catalog"
23645
+
23646
+
23602
23647
  class scout_catalog_Iso8601Timestamp(ConjureBeanType):
23603
23648
 
23604
23649
  @builtins.classmethod
@@ -37166,17 +37211,19 @@ class scout_compute_api_AssetChannel(ConjureBeanType):
37166
37211
  'data_scope_name': ConjureFieldDefinition('dataScopeName', scout_compute_api_StringConstant),
37167
37212
  'channel': ConjureFieldDefinition('channel', scout_compute_api_StringConstant),
37168
37213
  'additional_tags': ConjureFieldDefinition('additionalTags', Dict[str, scout_compute_api_StringConstant]),
37169
- 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str])
37214
+ 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str]),
37215
+ 'group_by_tags': ConjureFieldDefinition('groupByTags', OptionalTypeWrapper[scout_compute_api_StringSetConstant])
37170
37216
  }
37171
37217
 
37172
- __slots__: List[str] = ['_asset_rid', '_data_scope_name', '_channel', '_additional_tags', '_tags_to_group_by']
37218
+ __slots__: List[str] = ['_asset_rid', '_data_scope_name', '_channel', '_additional_tags', '_tags_to_group_by', '_group_by_tags']
37173
37219
 
37174
- def __init__(self, additional_tags: Dict[str, "scout_compute_api_StringConstant"], asset_rid: "scout_compute_api_StringConstant", channel: "scout_compute_api_StringConstant", data_scope_name: "scout_compute_api_StringConstant", tags_to_group_by: List[str]) -> None:
37220
+ def __init__(self, additional_tags: Dict[str, "scout_compute_api_StringConstant"], asset_rid: "scout_compute_api_StringConstant", channel: "scout_compute_api_StringConstant", data_scope_name: "scout_compute_api_StringConstant", tags_to_group_by: List[str], group_by_tags: Optional["scout_compute_api_StringSetConstant"] = None) -> None:
37175
37221
  self._asset_rid = asset_rid
37176
37222
  self._data_scope_name = data_scope_name
37177
37223
  self._channel = channel
37178
37224
  self._additional_tags = additional_tags
37179
37225
  self._tags_to_group_by = tags_to_group_by
37226
+ self._group_by_tags = group_by_tags
37180
37227
 
37181
37228
  @builtins.property
37182
37229
  def asset_rid(self) -> "scout_compute_api_StringConstant":
@@ -37202,10 +37249,14 @@ both sets of tag filters. For log series, include arg filters here in addition t
37202
37249
 
37203
37250
  @builtins.property
37204
37251
  def tags_to_group_by(self) -> List[str]:
37252
+ return self._tags_to_group_by
37253
+
37254
+ @builtins.property
37255
+ def group_by_tags(self) -> Optional["scout_compute_api_StringSetConstant"]:
37205
37256
  """Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned
37206
- with an entry for each grouping.
37257
+ with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified.
37207
37258
  """
37208
- return self._tags_to_group_by
37259
+ return self._group_by_tags
37209
37260
 
37210
37261
 
37211
37262
  scout_compute_api_AssetChannel.__name__ = "AssetChannel"
@@ -40499,16 +40550,18 @@ class scout_compute_api_DataSourceChannel(ConjureBeanType):
40499
40550
  'data_source_rid': ConjureFieldDefinition('dataSourceRid', scout_compute_api_StringConstant),
40500
40551
  'channel': ConjureFieldDefinition('channel', scout_compute_api_StringConstant),
40501
40552
  'tags': ConjureFieldDefinition('tags', Dict[str, scout_compute_api_StringConstant]),
40502
- 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str])
40553
+ 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str]),
40554
+ 'group_by_tags': ConjureFieldDefinition('groupByTags', OptionalTypeWrapper[scout_compute_api_StringSetConstant])
40503
40555
  }
40504
40556
 
40505
- __slots__: List[str] = ['_data_source_rid', '_channel', '_tags', '_tags_to_group_by']
40557
+ __slots__: List[str] = ['_data_source_rid', '_channel', '_tags', '_tags_to_group_by', '_group_by_tags']
40506
40558
 
40507
- def __init__(self, channel: "scout_compute_api_StringConstant", data_source_rid: "scout_compute_api_StringConstant", tags: Dict[str, "scout_compute_api_StringConstant"], tags_to_group_by: List[str]) -> None:
40559
+ def __init__(self, channel: "scout_compute_api_StringConstant", data_source_rid: "scout_compute_api_StringConstant", tags: Dict[str, "scout_compute_api_StringConstant"], tags_to_group_by: List[str], group_by_tags: Optional["scout_compute_api_StringSetConstant"] = None) -> None:
40508
40560
  self._data_source_rid = data_source_rid
40509
40561
  self._channel = channel
40510
40562
  self._tags = tags
40511
40563
  self._tags_to_group_by = tags_to_group_by
40564
+ self._group_by_tags = group_by_tags
40512
40565
 
40513
40566
  @builtins.property
40514
40567
  def data_source_rid(self) -> "scout_compute_api_StringConstant":
@@ -40527,10 +40580,14 @@ provided tag keys. For log series, include arg filters here in addition to tag f
40527
40580
 
40528
40581
  @builtins.property
40529
40582
  def tags_to_group_by(self) -> List[str]:
40583
+ return self._tags_to_group_by
40584
+
40585
+ @builtins.property
40586
+ def group_by_tags(self) -> Optional["scout_compute_api_StringSetConstant"]:
40530
40587
  """Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned
40531
- with an entry for each grouping.
40588
+ with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified.
40532
40589
  """
40533
- return self._tags_to_group_by
40590
+ return self._group_by_tags
40534
40591
 
40535
40592
 
40536
40593
  scout_compute_api_DataSourceChannel.__name__ = "DataSourceChannel"
@@ -47499,17 +47556,19 @@ class scout_compute_api_RunChannel(ConjureBeanType):
47499
47556
  'data_scope_name': ConjureFieldDefinition('dataScopeName', scout_compute_api_StringConstant),
47500
47557
  'channel': ConjureFieldDefinition('channel', scout_compute_api_StringConstant),
47501
47558
  'additional_tags': ConjureFieldDefinition('additionalTags', Dict[str, scout_compute_api_StringConstant]),
47502
- 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str])
47559
+ 'tags_to_group_by': ConjureFieldDefinition('tagsToGroupBy', List[str]),
47560
+ 'group_by_tags': ConjureFieldDefinition('groupByTags', OptionalTypeWrapper[scout_compute_api_StringSetConstant])
47503
47561
  }
47504
47562
 
47505
- __slots__: List[str] = ['_run_rid', '_data_scope_name', '_channel', '_additional_tags', '_tags_to_group_by']
47563
+ __slots__: List[str] = ['_run_rid', '_data_scope_name', '_channel', '_additional_tags', '_tags_to_group_by', '_group_by_tags']
47506
47564
 
47507
- def __init__(self, additional_tags: Dict[str, "scout_compute_api_StringConstant"], channel: "scout_compute_api_StringConstant", data_scope_name: "scout_compute_api_StringConstant", run_rid: "scout_compute_api_StringConstant", tags_to_group_by: List[str]) -> None:
47565
+ def __init__(self, additional_tags: Dict[str, "scout_compute_api_StringConstant"], channel: "scout_compute_api_StringConstant", data_scope_name: "scout_compute_api_StringConstant", run_rid: "scout_compute_api_StringConstant", tags_to_group_by: List[str], group_by_tags: Optional["scout_compute_api_StringSetConstant"] = None) -> None:
47508
47566
  self._run_rid = run_rid
47509
47567
  self._data_scope_name = data_scope_name
47510
47568
  self._channel = channel
47511
47569
  self._additional_tags = additional_tags
47512
47570
  self._tags_to_group_by = tags_to_group_by
47571
+ self._group_by_tags = group_by_tags
47513
47572
 
47514
47573
  @builtins.property
47515
47574
  def run_rid(self) -> "scout_compute_api_StringConstant":
@@ -47535,10 +47594,14 @@ both sets of tag filters. For log series, include arg filters here in addition t
47535
47594
 
47536
47595
  @builtins.property
47537
47596
  def tags_to_group_by(self) -> List[str]:
47597
+ return self._tags_to_group_by
47598
+
47599
+ @builtins.property
47600
+ def group_by_tags(self) -> Optional["scout_compute_api_StringSetConstant"]:
47538
47601
  """Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned
47539
- with an entry for each grouping.
47602
+ with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified.
47540
47603
  """
47541
- return self._tags_to_group_by
47604
+ return self._group_by_tags
47542
47605
 
47543
47606
 
47544
47607
  scout_compute_api_RunChannel.__name__ = "RunChannel"
@@ -26,6 +26,7 @@ from .._impl import (
26
26
  scout_catalog_HandleVisitor as HandleVisitor,
27
27
  scout_catalog_IngestProgressV2 as IngestProgressV2,
28
28
  scout_catalog_IngestStatus as IngestStatus,
29
+ scout_catalog_IngestTagMetadata as IngestTagMetadata,
29
30
  scout_catalog_Iso8601Timestamp as Iso8601Timestamp,
30
31
  scout_catalog_MarkFileIngestError as MarkFileIngestError,
31
32
  scout_catalog_MarkFileIngestSuccessful as MarkFileIngestSuccessful,
@@ -78,6 +79,7 @@ __all__ = [
78
79
  'HandleVisitor',
79
80
  'IngestProgressV2',
80
81
  'IngestStatus',
82
+ 'IngestTagMetadata',
81
83
  'Iso8601Timestamp',
82
84
  'MarkFileIngestError',
83
85
  'MarkFileIngestSuccessful',
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.743.0
3
+ Version: 0.745.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<4,>=2.8.0
@@ -1,5 +1,5 @@
1
- nominal_api/__init__.py,sha256=xd9OX1yjcqlZ2-MToB49uclZixkLZuP8XM4F4D4wKvE,1989
2
- nominal_api/_impl.py,sha256=NRotnq6FpuFOhGG5r1gb5GYgqOs6gItUN-MIfHtjzC4,3370837
1
+ nominal_api/__init__.py,sha256=wZ8Tfu932N45tWLn_UZz0Kx5OLJ86XXyPO3BoHO38dQ,1989
2
+ nominal_api/_impl.py,sha256=H92Cx1lHhJ4fLZe_g6MAy8vfOooUIrv-PeauwMlKT_s,3374319
3
3
  nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
4
4
  nominal_api/api/__init__.py,sha256=PMREKP7UhxJ1_gHkrlJET46qlDHksKMm6-woR1p6WnU,1970
5
5
  nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -24,7 +24,7 @@ nominal_api/scout/__init__.py,sha256=dZzrrqBeio2l0txhlNoHSfv6QsA9a3EVDp0_XpubUGk
24
24
  nominal_api/scout_api/__init__.py,sha256=MBFasDkc62-_Zqi-p6baBbtfvvhq_1bs0f5RuC5LdPM,865
25
25
  nominal_api/scout_asset_api/__init__.py,sha256=d3naKiiQL79GLo-JSv_hLtAXKRZUE9J3I5QNWNR0o0U,3124
26
26
  nominal_api/scout_assets/__init__.py,sha256=1ZyiolDjhxnrhyeUxW_KyeQ_q-6stlqd1I2d3HeZqUg,122
27
- nominal_api/scout_catalog/__init__.py,sha256=tkovUfQh4zf2Lko0AQ5BQ608TYeWIdP2jqD4KxTqk8A,4130
27
+ nominal_api/scout_catalog/__init__.py,sha256=DNtjCxXk3yGniLZaCcUJ590VICWZfMRArO5u0Q81uic,4213
28
28
  nominal_api/scout_channelvariables_api/__init__.py,sha256=Wahkyy-m3gEcaRFYU5ZV3beW-W4OeYnOs9Y4eirQO38,1033
29
29
  nominal_api/scout_chart_api/__init__.py,sha256=hkNhoFOmPYnLFeINiQXqya78wbAsx65DoKU0TpUwhQo,261
30
30
  nominal_api/scout_chartdefinition_api/__init__.py,sha256=6cSEjkqj2VAYkH0oMzTgZwB00HDleQuJuqtofC-fViQ,15457
@@ -74,7 +74,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=BwdqHLq_98LOsRV14JA3
74
74
  nominal_api/timeseries_seriescache/__init__.py,sha256=hL5hN8jKLEGE_fDiZzdASmWIrRjU6tncpmDeuc_47P4,150
75
75
  nominal_api/timeseries_seriescache_api/__init__.py,sha256=USBxFmNnVFdnhTPLvWi3UgsvBZ4Iz4ycNgBTi10F-zI,1603
76
76
  nominal_api/upload_api/__init__.py,sha256=7-XXuZUqKPV4AMWvxNpZPZ5vBun4x-AomXj3Vol_BN4,123
77
- nominal_api-0.743.0.dist-info/METADATA,sha256=38oYjOlKoXWn9rolpAjjtvtKvecgCZZLV3CM-HnSLqs,199
78
- nominal_api-0.743.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
79
- nominal_api-0.743.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
80
- nominal_api-0.743.0.dist-info/RECORD,,
77
+ nominal_api-0.745.0.dist-info/METADATA,sha256=14EFYXtG33hdpsNJ5e2umwq47Jmpa-ln7Tzi6TsQMXg,199
78
+ nominal_api-0.745.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
79
+ nominal_api-0.745.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
80
+ nominal_api-0.745.0.dist-info/RECORD,,