nominal-api 0.871.0__tar.gz → 0.873.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.871.0 → nominal_api-0.873.0}/PKG-INFO +1 -1
  2. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/__init__.py +1 -1
  3. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/_impl.py +166 -9
  4. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_compute_api/__init__.py +4 -0
  5. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_compute_resolved_api/__init__.py +2 -0
  6. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api.egg-info/PKG-INFO +1 -1
  7. {nominal_api-0.871.0 → nominal_api-0.873.0}/setup.py +1 -1
  8. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/api/__init__.py +0 -0
  9. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/api_ids/__init__.py +0 -0
  10. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/api_rids/__init__.py +0 -0
  11. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/attachments_api/__init__.py +0 -0
  12. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/authentication_api/__init__.py +0 -0
  13. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/authorization/__init__.py +0 -0
  14. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/comments_api/__init__.py +0 -0
  15. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/connect_download/__init__.py +0 -0
  16. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/datasource/__init__.py +0 -0
  17. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/datasource_api/__init__.py +0 -0
  18. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/datasource_logset/__init__.py +0 -0
  19. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/datasource_logset_api/__init__.py +0 -0
  20. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/datasource_pagination_api/__init__.py +0 -0
  21. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/event/__init__.py +0 -0
  22. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/ingest_api/__init__.py +0 -0
  23. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/ingest_workflow_api/__init__.py +0 -0
  24. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/module/__init__.py +0 -0
  25. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/module_internal/__init__.py +0 -0
  26. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/modules_api/__init__.py +0 -0
  27. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/persistent_compute_api/__init__.py +0 -0
  28. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/py.typed +0 -0
  29. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout/__init__.py +0 -0
  30. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_api/__init__.py +0 -0
  31. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_asset_api/__init__.py +0 -0
  32. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_assets/__init__.py +0 -0
  33. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_catalog/__init__.py +0 -0
  34. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_channelvariables_api/__init__.py +0 -0
  35. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_chart_api/__init__.py +0 -0
  36. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_chartdefinition_api/__init__.py +0 -0
  37. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_checklistexecution_api/__init__.py +0 -0
  38. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_checks_api/__init__.py +0 -0
  39. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_comparisonnotebook_api/__init__.py +0 -0
  40. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_comparisonrun_api/__init__.py +0 -0
  41. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_compute_api_deprecated/__init__.py +0 -0
  42. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_dataexport_api/__init__.py +0 -0
  43. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_datareview_api/__init__.py +0 -0
  44. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_datasource/__init__.py +0 -0
  45. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_datasource_connection/__init__.py +0 -0
  46. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_datasource_connection_api/__init__.py +0 -0
  47. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_datasource_connection_api_influx/__init__.py +0 -0
  48. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_favorites/__init__.py +0 -0
  49. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_favorites_api/__init__.py +0 -0
  50. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_integrations_api/__init__.py +0 -0
  51. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_internal_search_api/__init__.py +0 -0
  52. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_jobs_api/__init__.py +0 -0
  53. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_layout_api/__init__.py +0 -0
  54. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_metadata/__init__.py +0 -0
  55. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_notebook_api/__init__.py +0 -0
  56. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_plotting/__init__.py +0 -0
  57. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_rids_api/__init__.py +0 -0
  58. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_run_api/__init__.py +0 -0
  59. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_savedviews/__init__.py +0 -0
  60. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_savedviews_api/__init__.py +0 -0
  61. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_template_api/__init__.py +0 -0
  62. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_units_api/__init__.py +0 -0
  63. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_versioning_api/__init__.py +0 -0
  64. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_video/__init__.py +0 -0
  65. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_video_api/__init__.py +0 -0
  66. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/scout_workbookcommon_api/__init__.py +0 -0
  67. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/secrets_api/__init__.py +0 -0
  68. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/security_api_workspace/__init__.py +0 -0
  69. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/storage_datasource_api/__init__.py +0 -0
  70. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/storage_deletion_api/__init__.py +0 -0
  71. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/storage_series_api/__init__.py +0 -0
  72. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/storage_writer_api/__init__.py +0 -0
  73. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/themes_api/__init__.py +0 -0
  74. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_archetype/__init__.py +0 -0
  75. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_archetype_api/__init__.py +0 -0
  76. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_channelmetadata/__init__.py +0 -0
  77. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_channelmetadata_api/__init__.py +0 -0
  78. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_logicalseries/__init__.py +0 -0
  79. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_logicalseries_api/__init__.py +0 -0
  80. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_seriescache/__init__.py +0 -0
  81. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/timeseries_seriescache_api/__init__.py +0 -0
  82. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/upload_api/__init__.py +0 -0
  83. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api/usercreation_api/__init__.py +0 -0
  84. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api.egg-info/SOURCES.txt +0 -0
  85. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api.egg-info/dependency_links.txt +0 -0
  86. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api.egg-info/requires.txt +0 -0
  87. {nominal_api-0.871.0 → nominal_api-0.873.0}/nominal_api.egg-info/top_level.txt +0 -0
  88. {nominal_api-0.871.0 → nominal_api-0.873.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.871.0
3
+ Version: 0.873.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.871.0"
84
+ __version__ = "0.873.0"
85
85
 
@@ -40400,6 +40400,46 @@ scout_compute_api_AggregateNumericSeries.__qualname__ = "AggregateNumericSeries"
40400
40400
  scout_compute_api_AggregateNumericSeries.__module__ = "nominal_api.scout_compute_api"
40401
40401
 
40402
40402
 
40403
+ class scout_compute_api_AggregateUnderRangesSeries(ConjureBeanType):
40404
+ """Aggregates the input series under the ranges in the provided ranges series, and outputs a new series with one
40405
+ point at the start of each range, where the value is the aggregation result. If a range has no points, no
40406
+ point will be produced for it. If a range has no start, the point produced for it will be at the
40407
+ start of the compute request range.
40408
+ """
40409
+
40410
+ @builtins.classmethod
40411
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
40412
+ return {
40413
+ 'input': ConjureFieldDefinition('input', scout_compute_api_NumericSeries),
40414
+ 'ranges': ConjureFieldDefinition('ranges', scout_compute_api_RangeSeries),
40415
+ 'operation': ConjureFieldDefinition('operation', scout_compute_api_NumericAggregationFunction)
40416
+ }
40417
+
40418
+ __slots__: List[str] = ['_input', '_ranges', '_operation']
40419
+
40420
+ def __init__(self, input: "scout_compute_api_NumericSeries", operation: "scout_compute_api_NumericAggregationFunction", ranges: "scout_compute_api_RangeSeries") -> None:
40421
+ self._input = input
40422
+ self._ranges = ranges
40423
+ self._operation = operation
40424
+
40425
+ @builtins.property
40426
+ def input(self) -> "scout_compute_api_NumericSeries":
40427
+ return self._input
40428
+
40429
+ @builtins.property
40430
+ def ranges(self) -> "scout_compute_api_RangeSeries":
40431
+ return self._ranges
40432
+
40433
+ @builtins.property
40434
+ def operation(self) -> "scout_compute_api_NumericAggregationFunction":
40435
+ return self._operation
40436
+
40437
+
40438
+ scout_compute_api_AggregateUnderRangesSeries.__name__ = "AggregateUnderRangesSeries"
40439
+ scout_compute_api_AggregateUnderRangesSeries.__qualname__ = "AggregateUnderRangesSeries"
40440
+ scout_compute_api_AggregateUnderRangesSeries.__module__ = "nominal_api.scout_compute_api"
40441
+
40442
+
40403
40443
  class scout_compute_api_AllowNegativeValues(ConjureBeanType):
40404
40444
 
40405
40445
  @builtins.classmethod
@@ -44460,7 +44500,7 @@ scout_compute_api_Context.__module__ = "nominal_api.scout_compute_api"
44460
44500
 
44461
44501
 
44462
44502
  class scout_compute_api_Count(ConjureBeanType):
44463
- """The number of points inside the time window
44503
+ """The number of points inside the time window.
44464
44504
  """
44465
44505
 
44466
44506
  @builtins.classmethod
@@ -49478,6 +49518,7 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49478
49518
  _approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None
49479
49519
  _select1d_array_index: Optional["scout_compute_api_SelectIndexFrom1dNumericArraySeries"] = None
49480
49520
  _select_newest_points: Optional["scout_compute_api_SelectNewestPointsSeries"] = None
49521
+ _aggregate_under_ranges: Optional["scout_compute_api_AggregateUnderRangesSeries"] = None
49481
49522
 
49482
49523
  @builtins.classmethod
49483
49524
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -49515,7 +49556,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49515
49556
  'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_api_NumericThresholdFilterSeries),
49516
49557
  'approximate_filter': ConjureFieldDefinition('approximateFilter', scout_compute_api_NumericApproximateFilterSeries),
49517
49558
  'select1d_array_index': ConjureFieldDefinition('select1dArrayIndex', scout_compute_api_SelectIndexFrom1dNumericArraySeries),
49518
- 'select_newest_points': ConjureFieldDefinition('selectNewestPoints', scout_compute_api_SelectNewestPointsSeries)
49559
+ 'select_newest_points': ConjureFieldDefinition('selectNewestPoints', scout_compute_api_SelectNewestPointsSeries),
49560
+ 'aggregate_under_ranges': ConjureFieldDefinition('aggregateUnderRanges', scout_compute_api_AggregateUnderRangesSeries)
49519
49561
  }
49520
49562
 
49521
49563
  def __init__(
@@ -49554,10 +49596,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49554
49596
  approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None,
49555
49597
  select1d_array_index: Optional["scout_compute_api_SelectIndexFrom1dNumericArraySeries"] = None,
49556
49598
  select_newest_points: Optional["scout_compute_api_SelectNewestPointsSeries"] = None,
49599
+ aggregate_under_ranges: Optional["scout_compute_api_AggregateUnderRangesSeries"] = None,
49557
49600
  type_of_union: Optional[str] = None
49558
49601
  ) -> None:
49559
49602
  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:
49603
+ 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
49604
  raise ValueError('a union must contain a single member')
49562
49605
 
49563
49606
  if aggregate is not None:
@@ -49662,6 +49705,9 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49662
49705
  if select_newest_points is not None:
49663
49706
  self._select_newest_points = select_newest_points
49664
49707
  self._type = 'selectNewestPoints'
49708
+ if aggregate_under_ranges is not None:
49709
+ self._aggregate_under_ranges = aggregate_under_ranges
49710
+ self._type = 'aggregateUnderRanges'
49665
49711
 
49666
49712
  elif type_of_union == 'aggregate':
49667
49713
  if aggregate is None:
@@ -49833,6 +49879,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49833
49879
  raise ValueError('a union value must not be None')
49834
49880
  self._select_newest_points = select_newest_points
49835
49881
  self._type = 'selectNewestPoints'
49882
+ elif type_of_union == 'aggregateUnderRanges':
49883
+ if aggregate_under_ranges is None:
49884
+ raise ValueError('a union value must not be None')
49885
+ self._aggregate_under_ranges = aggregate_under_ranges
49886
+ self._type = 'aggregateUnderRanges'
49836
49887
 
49837
49888
  @builtins.property
49838
49889
  def aggregate(self) -> Optional["scout_compute_api_AggregateNumericSeries"]:
@@ -49970,6 +50021,10 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
49970
50021
  def select_newest_points(self) -> Optional["scout_compute_api_SelectNewestPointsSeries"]:
49971
50022
  return self._select_newest_points
49972
50023
 
50024
+ @builtins.property
50025
+ def aggregate_under_ranges(self) -> Optional["scout_compute_api_AggregateUnderRangesSeries"]:
50026
+ return self._aggregate_under_ranges
50027
+
49973
50028
  def accept(self, visitor) -> Any:
49974
50029
  if not isinstance(visitor, scout_compute_api_NumericSeriesVisitor):
49975
50030
  raise ValueError('{} is not an instance of scout_compute_api_NumericSeriesVisitor'.format(visitor.__class__.__name__))
@@ -50041,6 +50096,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
50041
50096
  return visitor._select1d_array_index(self.select1d_array_index)
50042
50097
  if self._type == 'selectNewestPoints' and self.select_newest_points is not None:
50043
50098
  return visitor._select_newest_points(self.select_newest_points)
50099
+ if self._type == 'aggregateUnderRanges' and self.aggregate_under_ranges is not None:
50100
+ return visitor._aggregate_under_ranges(self.aggregate_under_ranges)
50044
50101
 
50045
50102
 
50046
50103
  scout_compute_api_NumericSeries.__name__ = "NumericSeries"
@@ -50186,6 +50243,10 @@ class scout_compute_api_NumericSeriesVisitor:
50186
50243
  def _select_newest_points(self, select_newest_points: "scout_compute_api_SelectNewestPointsSeries") -> Any:
50187
50244
  pass
50188
50245
 
50246
+ @abstractmethod
50247
+ def _aggregate_under_ranges(self, aggregate_under_ranges: "scout_compute_api_AggregateUnderRangesSeries") -> Any:
50248
+ pass
50249
+
50189
50250
 
50190
50251
  scout_compute_api_NumericSeriesVisitor.__name__ = "NumericSeriesVisitor"
50191
50252
  scout_compute_api_NumericSeriesVisitor.__qualname__ = "NumericSeriesVisitor"
@@ -51391,6 +51452,8 @@ scout_compute_api_Range.__module__ = "nominal_api.scout_compute_api"
51391
51452
 
51392
51453
 
51393
51454
  class scout_compute_api_RangeAggregation(ConjureBeanType):
51455
+ """An aggregation value representing combined aggregation metrics for data over a range.
51456
+ """
51394
51457
 
51395
51458
  @builtins.classmethod
51396
51459
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -51399,17 +51462,19 @@ class scout_compute_api_RangeAggregation(ConjureBeanType):
51399
51462
  'min': ConjureFieldDefinition('min', float),
51400
51463
  'max': ConjureFieldDefinition('max', float),
51401
51464
  'standard_deviation': ConjureFieldDefinition('standardDeviation', float),
51402
- 'count': ConjureFieldDefinition('count', float)
51465
+ 'count': ConjureFieldDefinition('count', float),
51466
+ 'sum': ConjureFieldDefinition('sum', float)
51403
51467
  }
51404
51468
 
51405
- __slots__: List[str] = ['_average', '_min', '_max', '_standard_deviation', '_count']
51469
+ __slots__: List[str] = ['_average', '_min', '_max', '_standard_deviation', '_count', '_sum']
51406
51470
 
51407
- def __init__(self, average: float, count: float, max: float, min: float, standard_deviation: float) -> None:
51471
+ def __init__(self, average: float, count: float, max: float, min: float, standard_deviation: float, sum: float) -> None:
51408
51472
  self._average = average
51409
51473
  self._min = min
51410
51474
  self._max = max
51411
51475
  self._standard_deviation = standard_deviation
51412
51476
  self._count = count
51477
+ self._sum = sum
51413
51478
 
51414
51479
  @builtins.property
51415
51480
  def average(self) -> float:
@@ -51431,6 +51496,10 @@ class scout_compute_api_RangeAggregation(ConjureBeanType):
51431
51496
  def count(self) -> float:
51432
51497
  return self._count
51433
51498
 
51499
+ @builtins.property
51500
+ def sum(self) -> float:
51501
+ return self._sum
51502
+
51434
51503
 
51435
51504
  scout_compute_api_RangeAggregation.__name__ = "RangeAggregation"
51436
51505
  scout_compute_api_RangeAggregation.__qualname__ = "RangeAggregation"
@@ -51438,6 +51507,7 @@ scout_compute_api_RangeAggregation.__module__ = "nominal_api.scout_compute_api"
51438
51507
 
51439
51508
 
51440
51509
  class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51510
+ _sum: Optional["scout_compute_api_Summation"] = None
51441
51511
  _average: Optional["scout_compute_api_Average"] = None
51442
51512
  _min: Optional["scout_compute_api_Minimum"] = None
51443
51513
  _max: Optional["scout_compute_api_Maximum"] = None
@@ -51448,6 +51518,7 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51448
51518
  @builtins.classmethod
51449
51519
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
51450
51520
  return {
51521
+ 'sum': ConjureFieldDefinition('sum', scout_compute_api_Summation),
51451
51522
  'average': ConjureFieldDefinition('average', scout_compute_api_Average),
51452
51523
  'min': ConjureFieldDefinition('min', scout_compute_api_Minimum),
51453
51524
  'max': ConjureFieldDefinition('max', scout_compute_api_Maximum),
@@ -51458,6 +51529,7 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51458
51529
 
51459
51530
  def __init__(
51460
51531
  self,
51532
+ sum: Optional["scout_compute_api_Summation"] = None,
51461
51533
  average: Optional["scout_compute_api_Average"] = None,
51462
51534
  min: Optional["scout_compute_api_Minimum"] = None,
51463
51535
  max: Optional["scout_compute_api_Maximum"] = None,
@@ -51467,9 +51539,12 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51467
51539
  type_of_union: Optional[str] = None
51468
51540
  ) -> None:
51469
51541
  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:
51542
+ 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
51543
  raise ValueError('a union must contain a single member')
51472
51544
 
51545
+ if sum is not None:
51546
+ self._sum = sum
51547
+ self._type = 'sum'
51473
51548
  if average is not None:
51474
51549
  self._average = average
51475
51550
  self._type = 'average'
@@ -51489,6 +51564,11 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51489
51564
  self._all = all
51490
51565
  self._type = 'all'
51491
51566
 
51567
+ elif type_of_union == 'sum':
51568
+ if sum is None:
51569
+ raise ValueError('a union value must not be None')
51570
+ self._sum = sum
51571
+ self._type = 'sum'
51492
51572
  elif type_of_union == 'average':
51493
51573
  if average is None:
51494
51574
  raise ValueError('a union value must not be None')
@@ -51520,6 +51600,10 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51520
51600
  self._all = all
51521
51601
  self._type = 'all'
51522
51602
 
51603
+ @builtins.property
51604
+ def sum(self) -> Optional["scout_compute_api_Summation"]:
51605
+ return self._sum
51606
+
51523
51607
  @builtins.property
51524
51608
  def average(self) -> Optional["scout_compute_api_Average"]:
51525
51609
  return self._average
@@ -51547,6 +51631,8 @@ class scout_compute_api_RangeAggregationOperation(ConjureUnionType):
51547
51631
  def accept(self, visitor) -> Any:
51548
51632
  if not isinstance(visitor, scout_compute_api_RangeAggregationOperationVisitor):
51549
51633
  raise ValueError('{} is not an instance of scout_compute_api_RangeAggregationOperationVisitor'.format(visitor.__class__.__name__))
51634
+ if self._type == 'sum' and self.sum is not None:
51635
+ return visitor._sum(self.sum)
51550
51636
  if self._type == 'average' and self.average is not None:
51551
51637
  return visitor._average(self.average)
51552
51638
  if self._type == 'min' and self.min is not None:
@@ -51568,6 +51654,10 @@ scout_compute_api_RangeAggregationOperation.__module__ = "nominal_api.scout_comp
51568
51654
 
51569
51655
  class scout_compute_api_RangeAggregationOperationVisitor:
51570
51656
 
51657
+ @abstractmethod
51658
+ def _sum(self, sum: "scout_compute_api_Summation") -> Any:
51659
+ pass
51660
+
51571
51661
  @abstractmethod
51572
51662
  def _average(self, average: "scout_compute_api_Average") -> Any:
51573
51663
  pass
@@ -52134,6 +52224,11 @@ scout_compute_api_RangeSummary.__module__ = "nominal_api.scout_compute_api"
52134
52224
 
52135
52225
 
52136
52226
  class scout_compute_api_RangeValue(ConjureUnionType):
52227
+ """A value attached to a range. If there are no relevant data points in the range, this will be noPointsInRange
52228
+ for the range; otherwise, an Aggregation will be returned if this is produced by getting multiple aggregation
52229
+ values over a range (i.e. aggregating for all metrics over a range), and will be a double otherwise for
52230
+ singular values (i.e. aggregating for just the sum of data values over a range).
52231
+ """
52137
52232
  _double: Optional[float] = None
52138
52233
  _aggregation: Optional["scout_compute_api_RangeAggregation"] = None
52139
52234
  _no_points_in_range: Optional["api_Empty"] = None
@@ -54267,6 +54362,24 @@ scout_compute_api_SummarizeSeries.__qualname__ = "SummarizeSeries"
54267
54362
  scout_compute_api_SummarizeSeries.__module__ = "nominal_api.scout_compute_api"
54268
54363
 
54269
54364
 
54365
+ class scout_compute_api_Summation(ConjureBeanType):
54366
+ """The sum of points inside the time window.
54367
+ """
54368
+
54369
+ @builtins.classmethod
54370
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
54371
+ return {
54372
+ }
54373
+
54374
+ __slots__: List[str] = []
54375
+
54376
+
54377
+
54378
+ scout_compute_api_Summation.__name__ = "Summation"
54379
+ scout_compute_api_Summation.__qualname__ = "Summation"
54380
+ scout_compute_api_Summation.__module__ = "nominal_api.scout_compute_api"
54381
+
54382
+
54270
54383
  class scout_compute_api_TagFilter(ConjureBeanType):
54271
54384
  """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
54385
  values in the set. For a NOT_IN operator, it must not match any of the values in the set.
@@ -60563,6 +60676,7 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60563
60676
  _array_select: Optional["scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode"] = None
60564
60677
  _absolute_timestamp: Optional["scout_compute_resolved_api_AbsoluteTimestampSeriesNode"] = None
60565
60678
  _newest_points: Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"] = None
60679
+ _ranges_numeric_aggregation_to_numeric: Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"] = None
60566
60680
 
60567
60681
  @builtins.classmethod
60568
60682
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -60597,7 +60711,8 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60597
60711
  'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_resolved_api_NumericThresholdFilterSeriesNode),
60598
60712
  'array_select': ConjureFieldDefinition('arraySelect', scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode),
60599
60713
  'absolute_timestamp': ConjureFieldDefinition('absoluteTimestamp', scout_compute_resolved_api_AbsoluteTimestampSeriesNode),
60600
- 'newest_points': ConjureFieldDefinition('newestPoints', scout_compute_resolved_api_SelectNewestPointsSeriesNode)
60714
+ 'newest_points': ConjureFieldDefinition('newestPoints', scout_compute_resolved_api_SelectNewestPointsSeriesNode),
60715
+ 'ranges_numeric_aggregation_to_numeric': ConjureFieldDefinition('rangesNumericAggregationToNumeric', scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode)
60601
60716
  }
60602
60717
 
60603
60718
  def __init__(
@@ -60633,10 +60748,11 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60633
60748
  array_select: Optional["scout_compute_resolved_api_SelectIndexFromNumericArraySeriesNode"] = None,
60634
60749
  absolute_timestamp: Optional["scout_compute_resolved_api_AbsoluteTimestampSeriesNode"] = None,
60635
60750
  newest_points: Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"] = None,
60751
+ ranges_numeric_aggregation_to_numeric: Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"] = None,
60636
60752
  type_of_union: Optional[str] = None
60637
60753
  ) -> None:
60638
60754
  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:
60755
+ 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
60756
  raise ValueError('a union must contain a single member')
60641
60757
 
60642
60758
  if arithmetic is not None:
@@ -60732,6 +60848,9 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60732
60848
  if newest_points is not None:
60733
60849
  self._newest_points = newest_points
60734
60850
  self._type = 'newestPoints'
60851
+ if ranges_numeric_aggregation_to_numeric is not None:
60852
+ self._ranges_numeric_aggregation_to_numeric = ranges_numeric_aggregation_to_numeric
60853
+ self._type = 'rangesNumericAggregationToNumeric'
60735
60854
 
60736
60855
  elif type_of_union == 'arithmetic':
60737
60856
  if arithmetic is None:
@@ -60888,6 +61007,11 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
60888
61007
  raise ValueError('a union value must not be None')
60889
61008
  self._newest_points = newest_points
60890
61009
  self._type = 'newestPoints'
61010
+ elif type_of_union == 'rangesNumericAggregationToNumeric':
61011
+ if ranges_numeric_aggregation_to_numeric is None:
61012
+ raise ValueError('a union value must not be None')
61013
+ self._ranges_numeric_aggregation_to_numeric = ranges_numeric_aggregation_to_numeric
61014
+ self._type = 'rangesNumericAggregationToNumeric'
60891
61015
 
60892
61016
  @builtins.property
60893
61017
  def arithmetic(self) -> Optional["scout_compute_resolved_api_ArithmeticSeriesNode"]:
@@ -61013,6 +61137,10 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
61013
61137
  def newest_points(self) -> Optional["scout_compute_resolved_api_SelectNewestPointsSeriesNode"]:
61014
61138
  return self._newest_points
61015
61139
 
61140
+ @builtins.property
61141
+ def ranges_numeric_aggregation_to_numeric(self) -> Optional["scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode"]:
61142
+ return self._ranges_numeric_aggregation_to_numeric
61143
+
61016
61144
  def accept(self, visitor) -> Any:
61017
61145
  if not isinstance(visitor, scout_compute_resolved_api_NumericSeriesNodeVisitor):
61018
61146
  raise ValueError('{} is not an instance of scout_compute_resolved_api_NumericSeriesNodeVisitor'.format(visitor.__class__.__name__))
@@ -61078,6 +61206,8 @@ class scout_compute_resolved_api_NumericSeriesNode(ConjureUnionType):
61078
61206
  return visitor._absolute_timestamp(self.absolute_timestamp)
61079
61207
  if self._type == 'newestPoints' and self.newest_points is not None:
61080
61208
  return visitor._newest_points(self.newest_points)
61209
+ if self._type == 'rangesNumericAggregationToNumeric' and self.ranges_numeric_aggregation_to_numeric is not None:
61210
+ return visitor._ranges_numeric_aggregation_to_numeric(self.ranges_numeric_aggregation_to_numeric)
61081
61211
 
61082
61212
 
61083
61213
  scout_compute_resolved_api_NumericSeriesNode.__name__ = "NumericSeriesNode"
@@ -61211,6 +61341,10 @@ class scout_compute_resolved_api_NumericSeriesNodeVisitor:
61211
61341
  def _newest_points(self, newest_points: "scout_compute_resolved_api_SelectNewestPointsSeriesNode") -> Any:
61212
61342
  pass
61213
61343
 
61344
+ @abstractmethod
61345
+ def _ranges_numeric_aggregation_to_numeric(self, ranges_numeric_aggregation_to_numeric: "scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode") -> Any:
61346
+ pass
61347
+
61214
61348
 
61215
61349
  scout_compute_resolved_api_NumericSeriesNodeVisitor.__name__ = "NumericSeriesNodeVisitor"
61216
61350
  scout_compute_resolved_api_NumericSeriesNodeVisitor.__qualname__ = "NumericSeriesNodeVisitor"
@@ -62002,6 +62136,29 @@ scout_compute_resolved_api_RangesNumericAggregationNode.__qualname__ = "RangesNu
62002
62136
  scout_compute_resolved_api_RangesNumericAggregationNode.__module__ = "nominal_api.scout_compute_resolved_api"
62003
62137
 
62004
62138
 
62139
+ class scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode(ConjureBeanType):
62140
+
62141
+ @builtins.classmethod
62142
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
62143
+ return {
62144
+ 'input': ConjureFieldDefinition('input', scout_compute_resolved_api_RangesNumericAggregationNode)
62145
+ }
62146
+
62147
+ __slots__: List[str] = ['_input']
62148
+
62149
+ def __init__(self, input: "scout_compute_resolved_api_RangesNumericAggregationNode") -> None:
62150
+ self._input = input
62151
+
62152
+ @builtins.property
62153
+ def input(self) -> "scout_compute_resolved_api_RangesNumericAggregationNode":
62154
+ return self._input
62155
+
62156
+
62157
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__name__ = "RangesNumericAggregationToNumericSeriesNode"
62158
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__qualname__ = "RangesNumericAggregationToNumericSeriesNode"
62159
+ scout_compute_resolved_api_RangesNumericAggregationToNumericSeriesNode.__module__ = "nominal_api.scout_compute_resolved_api"
62160
+
62161
+
62005
62162
  class scout_compute_resolved_api_RawEnumSeriesNode(ConjureBeanType):
62006
62163
 
62007
62164
  @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.871.0
3
+ Version: 0.873.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.871.0',
9
+ version='0.873.0',
10
10
  python_requires='>=3.8',
11
11
  package_data={"": ["py.typed"]},
12
12
  packages=find_packages(),
File without changes