nominal-api 0.872.0__tar.gz → 0.874.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.
Files changed (88) hide show
  1. {nominal_api-0.872.0 → nominal_api-0.874.0}/PKG-INFO +1 -1
  2. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/__init__.py +1 -1
  3. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/_impl.py +174 -10
  4. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_compute_api/__init__.py +4 -0
  5. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_compute_resolved_api/__init__.py +2 -0
  6. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api.egg-info/PKG-INFO +1 -1
  7. {nominal_api-0.872.0 → nominal_api-0.874.0}/setup.py +1 -1
  8. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/api/__init__.py +0 -0
  9. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/api_ids/__init__.py +0 -0
  10. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/api_rids/__init__.py +0 -0
  11. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/attachments_api/__init__.py +0 -0
  12. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/authentication_api/__init__.py +0 -0
  13. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/authorization/__init__.py +0 -0
  14. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/comments_api/__init__.py +0 -0
  15. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/connect_download/__init__.py +0 -0
  16. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/datasource/__init__.py +0 -0
  17. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/datasource_api/__init__.py +0 -0
  18. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/datasource_logset/__init__.py +0 -0
  19. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/datasource_logset_api/__init__.py +0 -0
  20. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/datasource_pagination_api/__init__.py +0 -0
  21. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/event/__init__.py +0 -0
  22. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/ingest_api/__init__.py +0 -0
  23. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/ingest_workflow_api/__init__.py +0 -0
  24. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/module/__init__.py +0 -0
  25. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/module_internal/__init__.py +0 -0
  26. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/modules_api/__init__.py +0 -0
  27. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/persistent_compute_api/__init__.py +0 -0
  28. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/py.typed +0 -0
  29. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout/__init__.py +0 -0
  30. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_api/__init__.py +0 -0
  31. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_asset_api/__init__.py +0 -0
  32. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_assets/__init__.py +0 -0
  33. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_catalog/__init__.py +0 -0
  34. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_channelvariables_api/__init__.py +0 -0
  35. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_chart_api/__init__.py +0 -0
  36. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_chartdefinition_api/__init__.py +0 -0
  37. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_checklistexecution_api/__init__.py +0 -0
  38. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_checks_api/__init__.py +0 -0
  39. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_comparisonnotebook_api/__init__.py +0 -0
  40. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_comparisonrun_api/__init__.py +0 -0
  41. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_compute_api_deprecated/__init__.py +0 -0
  42. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_dataexport_api/__init__.py +0 -0
  43. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_datareview_api/__init__.py +0 -0
  44. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_datasource/__init__.py +0 -0
  45. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_datasource_connection/__init__.py +0 -0
  46. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_datasource_connection_api/__init__.py +0 -0
  47. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_datasource_connection_api_influx/__init__.py +0 -0
  48. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_favorites/__init__.py +0 -0
  49. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_favorites_api/__init__.py +0 -0
  50. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_integrations_api/__init__.py +0 -0
  51. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_internal_search_api/__init__.py +0 -0
  52. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_jobs_api/__init__.py +0 -0
  53. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_layout_api/__init__.py +0 -0
  54. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_metadata/__init__.py +0 -0
  55. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_notebook_api/__init__.py +0 -0
  56. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_plotting/__init__.py +0 -0
  57. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_rids_api/__init__.py +0 -0
  58. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_run_api/__init__.py +0 -0
  59. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_savedviews/__init__.py +0 -0
  60. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_savedviews_api/__init__.py +0 -0
  61. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_template_api/__init__.py +0 -0
  62. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_units_api/__init__.py +0 -0
  63. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_versioning_api/__init__.py +0 -0
  64. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_video/__init__.py +0 -0
  65. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_video_api/__init__.py +0 -0
  66. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/scout_workbookcommon_api/__init__.py +0 -0
  67. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/secrets_api/__init__.py +0 -0
  68. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/security_api_workspace/__init__.py +0 -0
  69. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/storage_datasource_api/__init__.py +0 -0
  70. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/storage_deletion_api/__init__.py +0 -0
  71. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/storage_series_api/__init__.py +0 -0
  72. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/storage_writer_api/__init__.py +0 -0
  73. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/themes_api/__init__.py +0 -0
  74. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_archetype/__init__.py +0 -0
  75. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_archetype_api/__init__.py +0 -0
  76. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_channelmetadata/__init__.py +0 -0
  77. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_channelmetadata_api/__init__.py +0 -0
  78. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_logicalseries/__init__.py +0 -0
  79. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_logicalseries_api/__init__.py +0 -0
  80. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_seriescache/__init__.py +0 -0
  81. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/timeseries_seriescache_api/__init__.py +0 -0
  82. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/upload_api/__init__.py +0 -0
  83. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api/usercreation_api/__init__.py +0 -0
  84. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api.egg-info/SOURCES.txt +0 -0
  85. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api.egg-info/dependency_links.txt +0 -0
  86. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api.egg-info/requires.txt +0 -0
  87. {nominal_api-0.872.0 → nominal_api-0.874.0}/nominal_api.egg-info/top_level.txt +0 -0
  88. {nominal_api-0.872.0 → nominal_api-0.874.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.872.0
3
+ Version: 0.874.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<4,>=2.8.0
@@ -81,5 +81,5 @@ __all__ = [
81
81
 
82
82
  __conjure_generator_version__ = "4.17.0"
83
83
 
84
- __version__ = "0.872.0"
84
+ __version__ = "0.874.0"
85
85
 
@@ -28475,10 +28475,17 @@ class scout_chartdefinition_api_FrequencyPlotTypeFft(ConjureBeanType):
28475
28475
  @builtins.classmethod
28476
28476
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
28477
28477
  return {
28478
+ 'window': ConjureFieldDefinition('window', OptionalTypeWrapper[scout_compute_api_FftWindow])
28478
28479
  }
28479
28480
 
28480
- __slots__: List[str] = []
28481
+ __slots__: List[str] = ['_window']
28482
+
28483
+ def __init__(self, window: Optional["scout_compute_api_FftWindow"] = None) -> None:
28484
+ self._window = window
28481
28485
 
28486
+ @builtins.property
28487
+ def window(self) -> Optional["scout_compute_api_FftWindow"]:
28488
+ return self._window
28482
28489
 
28483
28490
 
28484
28491
  scout_chartdefinition_api_FrequencyPlotTypeFft.__name__ = "FrequencyPlotTypeFft"
@@ -40400,6 +40407,46 @@ scout_compute_api_AggregateNumericSeries.__qualname__ = "AggregateNumericSeries"
40400
40407
  scout_compute_api_AggregateNumericSeries.__module__ = "nominal_api.scout_compute_api"
40401
40408
 
40402
40409
 
40410
+ class scout_compute_api_AggregateUnderRangesSeries(ConjureBeanType):
40411
+ """Aggregates the input series under the ranges in the provided ranges series, and outputs a new series with one
40412
+ point at the start of each range, where the value is the aggregation result. If a range has no points, no
40413
+ point will be produced for it. If a range has no start, the point produced for it will be at the
40414
+ start of the compute request range.
40415
+ """
40416
+
40417
+ @builtins.classmethod
40418
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
40419
+ return {
40420
+ 'input': ConjureFieldDefinition('input', scout_compute_api_NumericSeries),
40421
+ 'ranges': ConjureFieldDefinition('ranges', scout_compute_api_RangeSeries),
40422
+ 'operation': ConjureFieldDefinition('operation', scout_compute_api_NumericAggregationFunction)
40423
+ }
40424
+
40425
+ __slots__: List[str] = ['_input', '_ranges', '_operation']
40426
+
40427
+ def __init__(self, input: "scout_compute_api_NumericSeries", operation: "scout_compute_api_NumericAggregationFunction", ranges: "scout_compute_api_RangeSeries") -> None:
40428
+ self._input = input
40429
+ self._ranges = ranges
40430
+ self._operation = operation
40431
+
40432
+ @builtins.property
40433
+ def input(self) -> "scout_compute_api_NumericSeries":
40434
+ return self._input
40435
+
40436
+ @builtins.property
40437
+ def ranges(self) -> "scout_compute_api_RangeSeries":
40438
+ return self._ranges
40439
+
40440
+ @builtins.property
40441
+ def operation(self) -> "scout_compute_api_NumericAggregationFunction":
40442
+ return self._operation
40443
+
40444
+
40445
+ scout_compute_api_AggregateUnderRangesSeries.__name__ = "AggregateUnderRangesSeries"
40446
+ scout_compute_api_AggregateUnderRangesSeries.__qualname__ = "AggregateUnderRangesSeries"
40447
+ scout_compute_api_AggregateUnderRangesSeries.__module__ = "nominal_api.scout_compute_api"
40448
+
40449
+
40403
40450
  class scout_compute_api_AllowNegativeValues(ConjureBeanType):
40404
40451
 
40405
40452
  @builtins.classmethod
@@ -44460,7 +44507,7 @@ scout_compute_api_Context.__module__ = "nominal_api.scout_compute_api"
44460
44507
 
44461
44508
 
44462
44509
  class scout_compute_api_Count(ConjureBeanType):
44463
- """The number of points inside the time window
44510
+ """The number of points inside the time window.
44464
44511
  """
44465
44512
 
44466
44513
  @builtins.classmethod
@@ -49478,6 +49525,7 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49478
49525
  _approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None
49479
49526
  _select1d_array_index: Optional["scout_compute_api_SelectIndexFrom1dNumericArraySeries"] = None
49480
49527
  _select_newest_points: Optional["scout_compute_api_SelectNewestPointsSeries"] = None
49528
+ _aggregate_under_ranges: Optional["scout_compute_api_AggregateUnderRangesSeries"] = None
49481
49529
 
49482
49530
  @builtins.classmethod
49483
49531
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -49515,7 +49563,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49515
49563
  'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_api_NumericThresholdFilterSeries),
49516
49564
  'approximate_filter': ConjureFieldDefinition('approximateFilter', scout_compute_api_NumericApproximateFilterSeries),
49517
49565
  'select1d_array_index': ConjureFieldDefinition('select1dArrayIndex', scout_compute_api_SelectIndexFrom1dNumericArraySeries),
49518
- 'select_newest_points': ConjureFieldDefinition('selectNewestPoints', scout_compute_api_SelectNewestPointsSeries)
49566
+ 'select_newest_points': ConjureFieldDefinition('selectNewestPoints', scout_compute_api_SelectNewestPointsSeries),
49567
+ 'aggregate_under_ranges': ConjureFieldDefinition('aggregateUnderRanges', scout_compute_api_AggregateUnderRangesSeries)
49519
49568
  }
49520
49569
 
49521
49570
  def __init__(
@@ -49554,10 +49603,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49554
49603
  approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None,
49555
49604
  select1d_array_index: Optional["scout_compute_api_SelectIndexFrom1dNumericArraySeries"] = None,
49556
49605
  select_newest_points: Optional["scout_compute_api_SelectNewestPointsSeries"] = None,
49606
+ aggregate_under_ranges: Optional["scout_compute_api_AggregateUnderRangesSeries"] = None,
49557
49607
  type_of_union: Optional[str] = None
49558
49608
  ) -> None:
49559
49609
  if type_of_union is None:
49560
- if (aggregate is not None) + (arithmetic is not None) + (bit_operation is not None) + (count_duplicate is not None) + (cumulative_sum is not None) + (derivative is not None) + (integral is not None) + (max is not None) + (mean is not None) + (min is not None) + (offset is not None) + (product is not None) + (raw is not None) + (channel is not None) + (derived is not None) + (resample is not None) + (rolling_operation is not None) + (signal_filter is not None) + (sum is not None) + (scale is not None) + (time_difference is not None) + (absolute_timestamp is not None) + (time_range_filter is not None) + (time_shift is not None) + (unary_arithmetic is not None) + (binary_arithmetic is not None) + (union is not None) + (unit_conversion is not None) + (value_difference is not None) + (filter_transformation is not None) + (threshold_filter is not None) + (approximate_filter is not None) + (select1d_array_index is not None) + (select_newest_points is not None) != 1:
49610
+ if (aggregate is not None) + (arithmetic is not None) + (bit_operation is not None) + (count_duplicate is not None) + (cumulative_sum is not None) + (derivative is not None) + (integral is not None) + (max is not None) + (mean is not None) + (min is not None) + (offset is not None) + (product is not None) + (raw is not None) + (channel is not None) + (derived is not None) + (resample is not None) + (rolling_operation is not None) + (signal_filter is not None) + (sum is not None) + (scale is not None) + (time_difference is not None) + (absolute_timestamp is not None) + (time_range_filter is not None) + (time_shift is not None) + (unary_arithmetic is not None) + (binary_arithmetic is not None) + (union is not None) + (unit_conversion is not None) + (value_difference is not None) + (filter_transformation is not None) + (threshold_filter is not None) + (approximate_filter is not None) + (select1d_array_index is not None) + (select_newest_points is not None) + (aggregate_under_ranges is not None) != 1:
49561
49611
  raise ValueError('a union must contain a single member')
49562
49612
 
49563
49613
  if aggregate is not None:
@@ -49662,6 +49712,9 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49662
49712
  if select_newest_points is not None:
49663
49713
  self._select_newest_points = select_newest_points
49664
49714
  self._type = 'selectNewestPoints'
49715
+ if aggregate_under_ranges is not None:
49716
+ self._aggregate_under_ranges = aggregate_under_ranges
49717
+ self._type = 'aggregateUnderRanges'
49665
49718
 
49666
49719
  elif type_of_union == 'aggregate':
49667
49720
  if aggregate is None:
@@ -49833,6 +49886,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49833
49886
  raise ValueError('a union value must not be None')
49834
49887
  self._select_newest_points = select_newest_points
49835
49888
  self._type = 'selectNewestPoints'
49889
+ elif type_of_union == 'aggregateUnderRanges':
49890
+ if aggregate_under_ranges is None:
49891
+ raise ValueError('a union value must not be None')
49892
+ self._aggregate_under_ranges = aggregate_under_ranges
49893
+ self._type = 'aggregateUnderRanges'
49836
49894
 
49837
49895
  @builtins.property
49838
49896
  def aggregate(self) -> Optional["scout_compute_api_AggregateNumericSeries"]:
@@ -49970,6 +50028,10 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49970
50028
  def select_newest_points(self) -> Optional["scout_compute_api_SelectNewestPointsSeries"]:
49971
50029
  return self._select_newest_points
49972
50030
 
50031
+ @builtins.property
50032
+ def aggregate_under_ranges(self) -> Optional["scout_compute_api_AggregateUnderRangesSeries"]:
50033
+ return self._aggregate_under_ranges
50034
+
49973
50035
  def accept(self, visitor) -> Any:
49974
50036
  if not isinstance(visitor, scout_compute_api_NumericSeriesVisitor):
49975
50037
  raise ValueError('{} is not an instance of scout_compute_api_NumericSeriesVisitor'.format(visitor.__class__.__name__))
@@ -50041,6 +50103,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
50041
50103
  return visitor._select1d_array_index(self.select1d_array_index)
50042
50104
  if self._type == 'selectNewestPoints' and self.select_newest_points is not None:
50043
50105
  return visitor._select_newest_points(self.select_newest_points)
50106
+ if self._type == 'aggregateUnderRanges' and self.aggregate_under_ranges is not None:
50107
+ return visitor._aggregate_under_ranges(self.aggregate_under_ranges)
50044
50108
 
50045
50109
 
50046
50110
  scout_compute_api_NumericSeries.__name__ = "NumericSeries"
@@ -50186,6 +50250,10 @@ class scout_compute_api_NumericSeriesVisitor:
50186
50250
  def _select_newest_points(self, select_newest_points: "scout_compute_api_SelectNewestPointsSeries") -> Any:
50187
50251
  pass
50188
50252
 
50253
+ @abstractmethod
50254
+ def _aggregate_under_ranges(self, aggregate_under_ranges: "scout_compute_api_AggregateUnderRangesSeries") -> Any:
50255
+ pass
50256
+
50189
50257
 
50190
50258
  scout_compute_api_NumericSeriesVisitor.__name__ = "NumericSeriesVisitor"
50191
50259
  scout_compute_api_NumericSeriesVisitor.__qualname__ = "NumericSeriesVisitor"
@@ -51391,6 +51459,8 @@ scout_compute_api_Range.__module__ = "nominal_api.scout_compute_api"
51391
51459
 
51392
51460
 
51393
51461
  class scout_compute_api_RangeAggregation(ConjureBeanType):
51462
+ """An aggregation value representing combined aggregation metrics for data over a range.
51463
+ """
51394
51464
 
51395
51465
  @builtins.classmethod
51396
51466
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -51399,17 +51469,19 @@ class scout_compute_api_RangeAggregation(ConjureBeanType):
51399
51469
  'min': ConjureFieldDefinition('min', float),
51400
51470
  'max': ConjureFieldDefinition('max', float),
51401
51471
  'standard_deviation': ConjureFieldDefinition('standardDeviation', float),
51402
- 'count': ConjureFieldDefinition('count', float)
51472
+ 'count': ConjureFieldDefinition('count', float),
51473
+ 'sum': ConjureFieldDefinition('sum', float)
51403
51474
  }
51404
51475
 
51405
- __slots__: List[str] = ['_average', '_min', '_max', '_standard_deviation', '_count']
51476
+ __slots__: List[str] = ['_average', '_min', '_max', '_standard_deviation', '_count', '_sum']
51406
51477
 
51407
- def __init__(self, average: float, count: float, max: float, min: float, standard_deviation: float) -> None:
51478
+ def __init__(self, average: float, count: float, max: float, min: float, standard_deviation: float, sum: float) -> None:
51408
51479
  self._average = average
51409
51480
  self._min = min
51410
51481
  self._max = max
51411
51482
  self._standard_deviation = standard_deviation
51412
51483
  self._count = count
51484
+ self._sum = sum
51413
51485
 
51414
51486
  @builtins.property
51415
51487
  def average(self) -> float:
@@ -51431,6 +51503,10 @@ class scout_compute_api_RangeAggregation(ConjureBeanType):
51431
51503
  def count(self) -> float:
51432
51504
  return self._count
51433
51505
 
51506
+ @builtins.property
51507
+ def sum(self) -> float:
51508
+ return self._sum
51509
+
51434
51510
 
51435
51511
  scout_compute_api_RangeAggregation.__name__ = "RangeAggregation"
51436
51512
  scout_compute_api_RangeAggregation.__qualname__ = "RangeAggregation"
@@ -51438,6 +51514,7 @@ scout_compute_api_RangeAggregation.__module__ = "nominal_api.scout_compute_api"
51438
51514
 
51439
51515
 
51440
51516
  class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51517
+ _sum: Optional["scout_compute_api_Summation"] = None
51441
51518
  _average: Optional["scout_compute_api_Average"] = None
51442
51519
  _min: Optional["scout_compute_api_Minimum"] = None
51443
51520
  _max: Optional["scout_compute_api_Maximum"] = None
@@ -51448,6 +51525,7 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51448
51525
  @builtins.classmethod
51449
51526
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
51450
51527
  return {
51528
+ 'sum': ConjureFieldDefinition('sum', scout_compute_api_Summation),
51451
51529
  'average': ConjureFieldDefinition('average', scout_compute_api_Average),
51452
51530
  'min': ConjureFieldDefinition('min', scout_compute_api_Minimum),
51453
51531
  'max': ConjureFieldDefinition('max', scout_compute_api_Maximum),
@@ -51458,6 +51536,7 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51458
51536
 
51459
51537
  def __init__(
51460
51538
  self,
51539
+ sum: Optional["scout_compute_api_Summation"] = None,
51461
51540
  average: Optional["scout_compute_api_Average"] = None,
51462
51541
  min: Optional["scout_compute_api_Minimum"] = None,
51463
51542
  max: Optional["scout_compute_api_Maximum"] = None,
@@ -51467,9 +51546,12 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51467
51546
  type_of_union: Optional[str] = None
51468
51547
  ) -> None:
51469
51548
  if type_of_union is None:
51470
- if (average is not None) + (min is not None) + (max is not None) + (standard_deviation is not None) + (count is not None) + (all is not None) != 1:
51549
+ if (sum is not None) + (average is not None) + (min is not None) + (max is not None) + (standard_deviation is not None) + (count is not None) + (all is not None) != 1:
51471
51550
  raise ValueError('a union must contain a single member')
51472
51551
 
51552
+ if sum is not None:
51553
+ self._sum = sum
51554
+ self._type = 'sum'
51473
51555
  if average is not None:
51474
51556
  self._average = average
51475
51557
  self._type = 'average'
@@ -51489,6 +51571,11 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51489
51571
  self._all = all
51490
51572
  self._type = 'all'
51491
51573
 
51574
+ elif type_of_union == 'sum':
51575
+ if sum is None:
51576
+ raise ValueError('a union value must not be None')
51577
+ self._sum = sum
51578
+ self._type = 'sum'
51492
51579
  elif type_of_union == 'average':
51493
51580
  if average is None:
51494
51581
  raise ValueError('a union value must not be None')
@@ -51520,6 +51607,10 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51520
51607
  self._all = all
51521
51608
  self._type = 'all'
51522
51609
 
51610
+ @builtins.property
51611
+ def sum(self) -> Optional["scout_compute_api_Summation"]:
51612
+ return self._sum
51613
+
51523
51614
  @builtins.property
51524
51615
  def average(self) -> Optional["scout_compute_api_Average"]:
51525
51616
  return self._average
@@ -51547,6 +51638,8 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51547
51638
  def accept(self, visitor) -> Any:
51548
51639
  if not isinstance(visitor, scout_compute_api_RangeAggregationOperationVisitor):
51549
51640
  raise ValueError('{} is not an instance of scout_compute_api_RangeAggregationOperationVisitor'.format(visitor.__class__.__name__))
51641
+ if self._type == 'sum' and self.sum is not None:
51642
+ return visitor._sum(self.sum)
51550
51643
  if self._type == 'average' and self.average is not None:
51551
51644
  return visitor._average(self.average)
51552
51645
  if self._type == 'min' and self.min is not None:
@@ -51568,6 +51661,10 @@ scout_compute_api_RangeAggregationOperation.__module__ = "nominal_api.scout_comp
51568
51661
 
51569
51662
  class scout_compute_api_RangeAggregationOperationVisitor:
51570
51663
 
51664
+ @abstractmethod
51665
+ def _sum(self, sum: "scout_compute_api_Summation") -> Any:
51666
+ pass
51667
+
51571
51668
  @abstractmethod
51572
51669
  def _average(self, average: "scout_compute_api_Average") -> Any:
51573
51670
  pass
@@ -52134,6 +52231,11 @@ scout_compute_api_RangeSummary.__module__ = "nominal_api.scout_compute_api"
52134
52231
 
52135
52232
 
52136
52233
  class scout_compute_api_RangeValue(ConjureUnionType):
52234
+ """A value attached to a range. If there are no relevant data points in the range, this will be noPointsInRange
52235
+ for the range; otherwise, an Aggregation will be returned if this is produced by getting multiple aggregation
52236
+ values over a range (i.e. aggregating for all metrics over a range), and will be a double otherwise for
52237
+ singular values (i.e. aggregating for just the sum of data values over a range).
52238
+ """
52137
52239
  _double: Optional[float] = None
52138
52240
  _aggregation: Optional["scout_compute_api_RangeAggregation"] = None
52139
52241
  _no_points_in_range: Optional["api_Empty"] = None
@@ -54267,6 +54369,24 @@ scout_compute_api_SummarizeSeries.__qualname__ = "SummarizeSeries"
54267
54369
  scout_compute_api_SummarizeSeries.__module__ = "nominal_api.scout_compute_api"
54268
54370
 
54269
54371
 
54372
+ class scout_compute_api_Summation(ConjureBeanType):
54373
+ """The sum of points inside the time window.
54374
+ """
54375
+
54376
+ @builtins.classmethod
54377
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
54378
+ return {
54379
+ }
54380
+
54381
+ __slots__: List[str] = []
54382
+
54383
+
54384
+
54385
+ scout_compute_api_Summation.__name__ = "Summation"
54386
+ scout_compute_api_Summation.__qualname__ = "Summation"
54387
+ scout_compute_api_Summation.__module__ = "nominal_api.scout_compute_api"
54388
+
54389
+
54270
54390
  class scout_compute_api_TagFilter(ConjureBeanType):
54271
54391
  """A filter on a single tag key and set of values. For an IN operator, the tag key must match at least one of the
54272
54392
  values in the set. For a NOT_IN operator, it must not match any of the values in the set.
@@ -60563,6 +60683,7 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60563
60683
  _array_select: Optional["scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode"] = None
60564
60684
  _absolute_timestamp: Optional["scout_compute_resolved_api_AbsoluteTimestampSeriesNode"] = None
60565
60685
  _newest_points: Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"] = None
60686
+ _ranges_numeric_aggregation_to_numeric: Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"] = None
60566
60687
 
60567
60688
  @builtins.classmethod
60568
60689
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -60597,7 +60718,8 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60597
60718
  'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_resolved_api_NumericThresholdFilterSeriesNode),
60598
60719
  'array_select': ConjureFieldDefinition('arraySelect', scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode),
60599
60720
  'absolute_timestamp': ConjureFieldDefinition('absoluteTimestamp', scout_compute_resolved_api_AbsoluteTimestampSeriesNode),
60600
- 'newest_points': ConjureFieldDefinition('newestPoints', scout_compute_resolved_api_SelectNewestPointsSeriesNode)
60721
+ 'newest_points': ConjureFieldDefinition('newestPoints', scout_compute_resolved_api_SelectNewestPointsSeriesNode),
60722
+ 'ranges_numeric_aggregation_to_numeric': ConjureFieldDefinition('rangesNumericAggregationToNumeric', scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode)
60601
60723
  }
60602
60724
 
60603
60725
  def __init__(
@@ -60633,10 +60755,11 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60633
60755
  array_select: Optional["scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode"] = None,
60634
60756
  absolute_timestamp: Optional["scout_compute_resolved_api_AbsoluteTimestampSeriesNode"] = None,
60635
60757
  newest_points: Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"] = None,
60758
+ ranges_numeric_aggregation_to_numeric: Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"] = None,
60636
60759
  type_of_union: Optional[str] = None
60637
60760
  ) -> None:
60638
60761
  if type_of_union is None:
60639
- if (arithmetic is not None) + (bit_operation is not None) + (count_duplicate is not None) + (cumulative_sum is not None) + (derivative is not None) + (integral is not None) + (max is not None) + (mean is not None) + (min is not None) + (offset is not None) + (product is not None) + (raw is not None) + (resample is not None) + (rolling_operation is not None) + (aggregate is not None) + (signal_filter is not None) + (sum is not None) + (scale is not None) + (time_difference is not None) + (time_range_filter is not None) + (time_shift is not None) + (unary_arithmetic is not None) + (binary_arithmetic is not None) + (union is not None) + (unit_conversion is not None) + (value_difference is not None) + (filter_transformation is not None) + (threshold_filter is not None) + (array_select is not None) + (absolute_timestamp is not None) + (newest_points is not None) != 1:
60762
+ if (arithmetic is not None) + (bit_operation is not None) + (count_duplicate is not None) + (cumulative_sum is not None) + (derivative is not None) + (integral is not None) + (max is not None) + (mean is not None) + (min is not None) + (offset is not None) + (product is not None) + (raw is not None) + (resample is not None) + (rolling_operation is not None) + (aggregate is not None) + (signal_filter is not None) + (sum is not None) + (scale is not None) + (time_difference is not None) + (time_range_filter is not None) + (time_shift is not None) + (unary_arithmetic is not None) + (binary_arithmetic is not None) + (union is not None) + (unit_conversion is not None) + (value_difference is not None) + (filter_transformation is not None) + (threshold_filter is not None) + (array_select is not None) + (absolute_timestamp is not None) + (newest_points is not None) + (ranges_numeric_aggregation_to_numeric is not None) != 1:
60640
60763
  raise ValueError('a union must contain a single member')
60641
60764
 
60642
60765
  if arithmetic is not None:
@@ -60732,6 +60855,9 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60732
60855
  if newest_points is not None:
60733
60856
  self._newest_points = newest_points
60734
60857
  self._type = 'newestPoints'
60858
+ if ranges_numeric_aggregation_to_numeric is not None:
60859
+ self._ranges_numeric_aggregation_to_numeric = ranges_numeric_aggregation_to_numeric
60860
+ self._type = 'rangesNumericAggregationToNumeric'
60735
60861
 
60736
60862
  elif type_of_union == 'arithmetic':
60737
60863
  if arithmetic is None:
@@ -60888,6 +61014,11 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60888
61014
  raise ValueError('a union value must not be None')
60889
61015
  self._newest_points = newest_points
60890
61016
  self._type = 'newestPoints'
61017
+ elif type_of_union == 'rangesNumericAggregationToNumeric':
61018
+ if ranges_numeric_aggregation_to_numeric is None:
61019
+ raise ValueError('a union value must not be None')
61020
+ self._ranges_numeric_aggregation_to_numeric = ranges_numeric_aggregation_to_numeric
61021
+ self._type = 'rangesNumericAggregationToNumeric'
60891
61022
 
60892
61023
  @builtins.property
60893
61024
  def arithmetic(self) -> Optional["scout_compute_resolved_api_ArithmeticSeriesNode"]:
@@ -61013,6 +61144,10 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
61013
61144
  def newest_points(self) -> Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"]:
61014
61145
  return self._newest_points
61015
61146
 
61147
+ @builtins.property
61148
+ def ranges_numeric_aggregation_to_numeric(self) -> Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"]:
61149
+ return self._ranges_numeric_aggregation_to_numeric
61150
+
61016
61151
  def accept(self, visitor) -> Any:
61017
61152
  if not isinstance(visitor, scout_compute_resolved_api_NumericSeriesNodeVisitor):
61018
61153
  raise ValueError('{} is not an instance of scout_compute_resolved_api_NumericSeriesNodeVisitor'.format(visitor.__class__.__name__))
@@ -61078,6 +61213,8 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
61078
61213
  return visitor._absolute_timestamp(self.absolute_timestamp)
61079
61214
  if self._type == 'newestPoints' and self.newest_points is not None:
61080
61215
  return visitor._newest_points(self.newest_points)
61216
+ if self._type == 'rangesNumericAggregationToNumeric' and self.ranges_numeric_aggregation_to_numeric is not None:
61217
+ return visitor._ranges_numeric_aggregation_to_numeric(self.ranges_numeric_aggregation_to_numeric)
61081
61218
 
61082
61219
 
61083
61220
  scout_compute_resolved_api_NumericSeriesNode.__name__ = "NumericSeriesNode"
@@ -61211,6 +61348,10 @@ class scout_compute_resolved_api_NumericSeriesNodeVisitor:
61211
61348
  def _newest_points(self, newest_points: "scout_compute_resolved_api_SelectNewestPointsSeriesNode") -> Any:
61212
61349
  pass
61213
61350
 
61351
+ @abstractmethod
61352
+ def _ranges_numeric_aggregation_to_numeric(self, ranges_numeric_aggregation_to_numeric: "scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode") -> Any:
61353
+ pass
61354
+
61214
61355
 
61215
61356
  scout_compute_resolved_api_NumericSeriesNodeVisitor.__name__ = "NumericSeriesNodeVisitor"
61216
61357
  scout_compute_resolved_api_NumericSeriesNodeVisitor.__qualname__ = "NumericSeriesNodeVisitor"
@@ -62002,6 +62143,29 @@ scout_compute_resolved_api_RangesNumericAggregationNode.__qualname__ = "RangesNu
62002
62143
  scout_compute_resolved_api_RangesNumericAggregationNode.__module__ = "nominal_api.scout_compute_resolved_api"
62003
62144
 
62004
62145
 
62146
+ class scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode(ConjureBeanType):
62147
+
62148
+ @builtins.classmethod
62149
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
62150
+ return {
62151
+ 'input': ConjureFieldDefinition('input', scout_compute_resolved_api_RangesNumericAggregationNode)
62152
+ }
62153
+
62154
+ __slots__: List[str] = ['_input']
62155
+
62156
+ def __init__(self, input: "scout_compute_resolved_api_RangesNumericAggregationNode") -> None:
62157
+ self._input = input
62158
+
62159
+ @builtins.property
62160
+ def input(self) -> "scout_compute_resolved_api_RangesNumericAggregationNode":
62161
+ return self._input
62162
+
62163
+
62164
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__name__ = "RangesNumericAggregationToNumericSeriesNode"
62165
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__qualname__ = "RangesNumericAggregationToNumericSeriesNode"
62166
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__module__ = "nominal_api.scout_compute_resolved_api"
62167
+
62168
+
62005
62169
  class scout_compute_resolved_api_RawEnumSeriesNode(ConjureBeanType):
62006
62170
 
62007
62171
  @builtins.classmethod
@@ -5,6 +5,7 @@ from .._impl import (
5
5
  scout_compute_api_AfterPersistenceWindow as AfterPersistenceWindow,
6
6
  scout_compute_api_AggregateEnumSeries as AggregateEnumSeries,
7
7
  scout_compute_api_AggregateNumericSeries as AggregateNumericSeries,
8
+ scout_compute_api_AggregateUnderRangesSeries as AggregateUnderRangesSeries,
8
9
  scout_compute_api_AllowNegativeValues as AllowNegativeValues,
9
10
  scout_compute_api_ApproximateThresholdOperator as ApproximateThresholdOperator,
10
11
  scout_compute_api_ApproximateThresholdRanges as ApproximateThresholdRanges,
@@ -325,6 +326,7 @@ from .._impl import (
325
326
  scout_compute_api_SummarizeGeo as SummarizeGeo,
326
327
  scout_compute_api_SummarizeRanges as SummarizeRanges,
327
328
  scout_compute_api_SummarizeSeries as SummarizeSeries,
329
+ scout_compute_api_Summation as Summation,
328
330
  scout_compute_api_TagFilter as TagFilter,
329
331
  scout_compute_api_TagFilterOperator as TagFilterOperator,
330
332
  scout_compute_api_TagFilterValidationErrorType as TagFilterValidationErrorType,
@@ -367,6 +369,7 @@ __all__ = [
367
369
  'AfterPersistenceWindow',
368
370
  'AggregateEnumSeries',
369
371
  'AggregateNumericSeries',
372
+ 'AggregateUnderRangesSeries',
370
373
  'AllowNegativeValues',
371
374
  'ApproximateThresholdOperator',
372
375
  'ApproximateThresholdRanges',
@@ -686,6 +689,7 @@ __all__ = [
686
689
  'SummarizeGeo',
687
690
  'SummarizeRanges',
688
691
  'SummarizeSeries',
692
+ 'Summation',
689
693
  'TagFilter',
690
694
  'TagFilterOperator',
691
695
  'TagFilterValidationErrorType',
@@ -104,6 +104,7 @@ from .._impl import (
104
104
  scout_compute_resolved_api_RangesNode as RangesNode,
105
105
  scout_compute_resolved_api_RangesNodeVisitor as RangesNodeVisitor,
106
106
  scout_compute_resolved_api_RangesNumericAggregationNode as RangesNumericAggregationNode,
107
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode as RangesNumericAggregationToNumericSeriesNode,
107
108
  scout_compute_resolved_api_RawEnumSeriesNode as RawEnumSeriesNode,
108
109
  scout_compute_resolved_api_RawLogSeriesNode as RawLogSeriesNode,
109
110
  scout_compute_resolved_api_RawNumericSeriesNode as RawNumericSeriesNode,
@@ -264,6 +265,7 @@ __all__ = [
264
265
  'RangesNode',
265
266
  'RangesNodeVisitor',
266
267
  'RangesNumericAggregationNode',
268
+ 'RangesNumericAggregationToNumericSeriesNode',
267
269
  'RawEnumSeriesNode',
268
270
  'RawLogSeriesNode',
269
271
  'RawNumericSeriesNode',
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.872.0
3
+ Version: 0.874.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<4,>=2.8.0
@@ -6,7 +6,7 @@ from setuptools import (
6
6
 
7
7
  setup(
8
8
  name='nominal-api',
9
- version='0.872.0',
9
+ version='0.874.0',
10
10
  python_requires='>=3.8',
11
11
  package_data={"": ["py.typed"]},
12
12
  packages=find_packages(),
File without changes