nominal-api 0.547.0__py3-none-any.whl → 0.548.0__py3-none-any.whl

nominal_api/__init__.py

@@ -68,5 +68,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.547.0"
+__version__ = "0.548.0"
 

nominal_api/_impl.py

@@ -27483,6 +27483,74 @@ scout_compute_api_AllowNegativeValues.__qualname__ = "AllowNegativeValues"
 scout_compute_api_AllowNegativeValues.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_ApproximateThresholdOperator(ConjureEnumType):
+
+    EQUAL_TO = 'EQUAL_TO'
+    '''EQUAL_TO'''
+    NOT_EQUAL_TO = 'NOT_EQUAL_TO'
+    '''NOT_EQUAL_TO'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_compute_api_ApproximateThresholdOperator.__name__ = "ApproximateThresholdOperator"
+scout_compute_api_ApproximateThresholdOperator.__qualname__ = "ApproximateThresholdOperator"
+scout_compute_api_ApproximateThresholdOperator.__module__ = "nominal_api.scout_compute_api"
+
+
+class scout_compute_api_ApproximateThresholdRanges(ConjureBeanType):
+    """
+    Produces a list of ranges for which the threshold condition is satisfied.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'input': ConjureFieldDefinition('input', scout_compute_api_NumericSeries),
+            'threshold': ConjureFieldDefinition('threshold', scout_compute_api_DoubleConstant),
+            'tolerance': ConjureFieldDefinition('tolerance', scout_compute_api_DoubleConstant),
+            'operator': ConjureFieldDefinition('operator', scout_compute_api_ApproximateThresholdOperator),
+            'persistence_window_configuration': ConjureFieldDefinition('persistenceWindowConfiguration', OptionalTypeWrapper[scout_compute_api_PersistenceWindowConfiguration])
+        }
+
+    __slots__: List[str] = ['_input', '_threshold', '_tolerance', '_operator', '_persistence_window_configuration']
+
+    def __init__(self, input: "scout_compute_api_NumericSeries", operator: "scout_compute_api_ApproximateThresholdOperator", threshold: "scout_compute_api_DoubleConstant", tolerance: "scout_compute_api_DoubleConstant", persistence_window_configuration: Optional["scout_compute_api_PersistenceWindowConfiguration"] = None) -> None:
+        self._input = input
+        self._threshold = threshold
+        self._tolerance = tolerance
+        self._operator = operator
+        self._persistence_window_configuration = persistence_window_configuration
+
+    @builtins.property
+    def input(self) -> "scout_compute_api_NumericSeries":
+        return self._input
+
+    @builtins.property
+    def threshold(self) -> "scout_compute_api_DoubleConstant":
+        return self._threshold
+
+    @builtins.property
+    def tolerance(self) -> "scout_compute_api_DoubleConstant":
+        return self._tolerance
+
+    @builtins.property
+    def operator(self) -> "scout_compute_api_ApproximateThresholdOperator":
+        return self._operator
+
+    @builtins.property
+    def persistence_window_configuration(self) -> Optional["scout_compute_api_PersistenceWindowConfiguration"]:
+        return self._persistence_window_configuration
+
+
+scout_compute_api_ApproximateThresholdRanges.__name__ = "ApproximateThresholdRanges"
+scout_compute_api_ApproximateThresholdRanges.__qualname__ = "ApproximateThresholdRanges"
+scout_compute_api_ApproximateThresholdRanges.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_ArithmeticSeries(ConjureBeanType):
 
     @builtins.classmethod
@@ -32913,6 +32981,50 @@ scout_compute_api_NumericAggregationFunction.__qualname__ = "NumericAggregationF
 scout_compute_api_NumericAggregationFunction.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_NumericApproximateFilterSeries(ConjureBeanType):
+    """
+    Outputs the values of the numeric plot value that are approximately equal to the threshold value.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'input': ConjureFieldDefinition('input', scout_compute_api_NumericSeries),
+            'threshold': ConjureFieldDefinition('threshold', scout_compute_api_DoubleConstant),
+            'tolerance': ConjureFieldDefinition('tolerance', scout_compute_api_DoubleConstant),
+            'operator': ConjureFieldDefinition('operator', scout_compute_api_ApproximateThresholdOperator)
+        }
+
+    __slots__: List[str] = ['_input', '_threshold', '_tolerance', '_operator']
+
+    def __init__(self, input: "scout_compute_api_NumericSeries", operator: "scout_compute_api_ApproximateThresholdOperator", threshold: "scout_compute_api_DoubleConstant", tolerance: "scout_compute_api_DoubleConstant") -> None:
+        self._input = input
+        self._threshold = threshold
+        self._tolerance = tolerance
+        self._operator = operator
+
+    @builtins.property
+    def input(self) -> "scout_compute_api_NumericSeries":
+        return self._input
+
+    @builtins.property
+    def threshold(self) -> "scout_compute_api_DoubleConstant":
+        return self._threshold
+
+    @builtins.property
+    def tolerance(self) -> "scout_compute_api_DoubleConstant":
+        return self._tolerance
+
+    @builtins.property
+    def operator(self) -> "scout_compute_api_ApproximateThresholdOperator":
+        return self._operator
+
+
+scout_compute_api_NumericApproximateFilterSeries.__name__ = "NumericApproximateFilterSeries"
+scout_compute_api_NumericApproximateFilterSeries.__qualname__ = "NumericApproximateFilterSeries"
+scout_compute_api_NumericApproximateFilterSeries.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_NumericBucket(ConjureBeanType):
 
     @builtins.classmethod
@@ -33358,6 +33470,7 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
     _value_difference: Optional["scout_compute_api_ValueDifferenceSeries"] = None
     _filter_transformation: Optional["scout_compute_api_NumericFilterTransformationSeries"] = None
     _threshold_filter: Optional["scout_compute_api_NumericThresholdFilterSeries"] = None
+    _approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -33391,7 +33504,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
             'unit_conversion': ConjureFieldDefinition('unitConversion', scout_compute_api_UnitConversionSeries),
             'value_difference': ConjureFieldDefinition('valueDifference', scout_compute_api_ValueDifferenceSeries),
             'filter_transformation': ConjureFieldDefinition('filterTransformation', scout_compute_api_NumericFilterTransformationSeries),
-            'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_api_NumericThresholdFilterSeries)
+            'threshold_filter': ConjureFieldDefinition('thresholdFilter', scout_compute_api_NumericThresholdFilterSeries),
+            'approximate_filter': ConjureFieldDefinition('approximateFilter', scout_compute_api_NumericApproximateFilterSeries)
         }
 
     def __init__(
@@ -33426,10 +33540,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
             value_difference: Optional["scout_compute_api_ValueDifferenceSeries"] = None,
             filter_transformation: Optional["scout_compute_api_NumericFilterTransformationSeries"] = None,
             threshold_filter: Optional["scout_compute_api_NumericThresholdFilterSeries"] = None,
+            approximate_filter: Optional["scout_compute_api_NumericApproximateFilterSeries"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            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) + (function 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) + (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) + (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) != 1:
+            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) + (function 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) + (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) + (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) != 1:
                 raise ValueError('a union must contain a single member')
 
             if aggregate is not None:
@@ -33522,6 +33637,9 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
             if threshold_filter is not None:
                 self._threshold_filter = threshold_filter
                 self._type = 'thresholdFilter'
+            if approximate_filter is not None:
+                self._approximate_filter = approximate_filter
+                self._type = 'approximateFilter'
 
         elif type_of_union == 'aggregate':
             if aggregate is None:
@@ -33673,6 +33791,11 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._threshold_filter = threshold_filter
             self._type = 'thresholdFilter'
+        elif type_of_union == 'approximateFilter':
+            if approximate_filter is None:
+                raise ValueError('a union value must not be None')
+            self._approximate_filter = approximate_filter
+            self._type = 'approximateFilter'
 
     @builtins.property
     def aggregate(self) -> Optional["scout_compute_api_AggregateNumericSeries"]:
@@ -33794,6 +33917,10 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
     def threshold_filter(self) -> Optional["scout_compute_api_NumericThresholdFilterSeries"]:
         return self._threshold_filter
 
+    @builtins.property
+    def approximate_filter(self) -> Optional["scout_compute_api_NumericApproximateFilterSeries"]:
+        return self._approximate_filter
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_compute_api_NumericSeriesVisitor):
             raise ValueError('{} is not an instance of scout_compute_api_NumericSeriesVisitor'.format(visitor.__class__.__name__))
@@ -33857,6 +33984,8 @@ class scout_compute_api_NumericSeries(ConjureUnionType):
             return visitor._filter_transformation(self.filter_transformation)
         if self._type == 'thresholdFilter' and self.threshold_filter is not None:
             return visitor._threshold_filter(self.threshold_filter)
+        if self._type == 'approximateFilter' and self.approximate_filter is not None:
+            return visitor._approximate_filter(self.approximate_filter)
 
 
 scout_compute_api_NumericSeries.__name__ = "NumericSeries"
@@ -33986,6 +34115,10 @@ class scout_compute_api_NumericSeriesVisitor:
     def _threshold_filter(self, threshold_filter: "scout_compute_api_NumericThresholdFilterSeries") -> Any:
         pass
 
+    @abstractmethod
+    def _approximate_filter(self, approximate_filter: "scout_compute_api_NumericApproximateFilterSeries") -> Any:
+        pass
+
 
 scout_compute_api_NumericSeriesVisitor.__name__ = "NumericSeriesVisitor"
 scout_compute_api_NumericSeriesVisitor.__qualname__ = "NumericSeriesVisitor"
@@ -34910,6 +35043,7 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
     _intersect_range: Optional["scout_compute_api_IntersectRanges"] = None
     _not_: Optional["scout_compute_api_NotRanges"] = None
     _on_change: Optional["scout_compute_api_OnChangeRanges"] = None
+    _approximate_threshold: Optional["scout_compute_api_ApproximateThresholdRanges"] = None
     _min_max_threshold: Optional["scout_compute_api_MinMaxThresholdRanges"] = None
     _peak: Optional["scout_compute_api_PeakRanges"] = None
     _raw: Optional["scout_compute_api_Reference"] = None
@@ -34930,6 +35064,7 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             'intersect_range': ConjureFieldDefinition('intersectRange', scout_compute_api_IntersectRanges),
             'not_': ConjureFieldDefinition('not', scout_compute_api_NotRanges),
             'on_change': ConjureFieldDefinition('onChange', scout_compute_api_OnChangeRanges),
+            'approximate_threshold': ConjureFieldDefinition('approximateThreshold', scout_compute_api_ApproximateThresholdRanges),
             'min_max_threshold': ConjureFieldDefinition('minMaxThreshold', scout_compute_api_MinMaxThresholdRanges),
             'peak': ConjureFieldDefinition('peak', scout_compute_api_PeakRanges),
             'raw': ConjureFieldDefinition('raw', scout_compute_api_Reference),
@@ -34950,6 +35085,7 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             intersect_range: Optional["scout_compute_api_IntersectRanges"] = None,
             not_: Optional["scout_compute_api_NotRanges"] = None,
             on_change: Optional["scout_compute_api_OnChangeRanges"] = None,
+            approximate_threshold: Optional["scout_compute_api_ApproximateThresholdRanges"] = None,
             min_max_threshold: Optional["scout_compute_api_MinMaxThresholdRanges"] = None,
             peak: Optional["scout_compute_api_PeakRanges"] = None,
             raw: Optional["scout_compute_api_Reference"] = None,
@@ -34964,7 +35100,7 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (enum_filter is not None) + (function is not None) + (intersect_range is not None) + (not_ is not None) + (on_change is not None) + (min_max_threshold is not None) + (peak is not None) + (raw is not None) + (series_crossover_ranges_node is not None) + (series_equality_ranges_node is not None) + (enum_series_equality_ranges_node is not None) + (stale_range is not None) + (threshold is not None) + (union_range is not None) + (range_numeric_aggregation is not None) + (stability_detection is not None) != 1:
+            if (enum_filter is not None) + (function is not None) + (intersect_range is not None) + (not_ is not None) + (on_change is not None) + (approximate_threshold is not None) + (min_max_threshold is not None) + (peak is not None) + (raw is not None) + (series_crossover_ranges_node is not None) + (series_equality_ranges_node is not None) + (enum_series_equality_ranges_node is not None) + (stale_range is not None) + (threshold is not None) + (union_range is not None) + (range_numeric_aggregation is not None) + (stability_detection is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if enum_filter is not None:
@@ -34982,6 +35118,9 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             if on_change is not None:
                 self._on_change = on_change
                 self._type = 'onChange'
+            if approximate_threshold is not None:
+                self._approximate_threshold = approximate_threshold
+                self._type = 'approximateThreshold'
             if min_max_threshold is not None:
                 self._min_max_threshold = min_max_threshold
                 self._type = 'minMaxThreshold'
@@ -35041,6 +35180,11 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._on_change = on_change
             self._type = 'onChange'
+        elif type_of_union == 'approximateThreshold':
+            if approximate_threshold is None:
+                raise ValueError('a union value must not be None')
+            self._approximate_threshold = approximate_threshold
+            self._type = 'approximateThreshold'
         elif type_of_union == 'minMaxThreshold':
             if min_max_threshold is None:
                 raise ValueError('a union value must not be None')
@@ -35117,6 +35261,10 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
     def on_change(self) -> Optional["scout_compute_api_OnChangeRanges"]:
         return self._on_change
 
+    @builtins.property
+    def approximate_threshold(self) -> Optional["scout_compute_api_ApproximateThresholdRanges"]:
+        return self._approximate_threshold
+
     @builtins.property
     def min_max_threshold(self) -> Optional["scout_compute_api_MinMaxThresholdRanges"]:
         """
@@ -35180,6 +35328,8 @@ class scout_compute_api_RangeSeries(ConjureUnionType):
             return visitor._not(self.not_)
         if self._type == 'onChange' and self.on_change is not None:
             return visitor._on_change(self.on_change)
+        if self._type == 'approximateThreshold' and self.approximate_threshold is not None:
+            return visitor._approximate_threshold(self.approximate_threshold)
         if self._type == 'minMaxThreshold' and self.min_max_threshold is not None:
             return visitor._min_max_threshold(self.min_max_threshold)
         if self._type == 'peak' and self.peak is not None:
@@ -35231,6 +35381,10 @@ class scout_compute_api_RangeSeriesVisitor:
     def _on_change(self, on_change: "scout_compute_api_OnChangeRanges") -> Any:
         pass
 
+    @abstractmethod
+    def _approximate_threshold(self, approximate_threshold: "scout_compute_api_ApproximateThresholdRanges") -> Any:
+        pass
+
     @abstractmethod
     def _min_max_threshold(self, min_max_threshold: "scout_compute_api_MinMaxThresholdRanges") -> Any:
         pass

nominal_api/scout_compute_api/__init__.py

@@ -5,6 +5,8 @@ from .._impl import (
     scout_compute_api_AggregateEnumSeries as AggregateEnumSeries,
     scout_compute_api_AggregateNumericSeries as AggregateNumericSeries,
     scout_compute_api_AllowNegativeValues as AllowNegativeValues,
+    scout_compute_api_ApproximateThresholdOperator as ApproximateThresholdOperator,
+    scout_compute_api_ApproximateThresholdRanges as ApproximateThresholdRanges,
     scout_compute_api_ArithmeticSeries as ArithmeticSeries,
     scout_compute_api_AssetChannel as AssetChannel,
     scout_compute_api_Average as Average,
@@ -150,6 +152,7 @@ from .._impl import (
     scout_compute_api_NegativeValueConfigurationVisitor as NegativeValueConfigurationVisitor,
     scout_compute_api_NotRanges as NotRanges,
     scout_compute_api_NumericAggregationFunction as NumericAggregationFunction,
+    scout_compute_api_NumericApproximateFilterSeries as NumericApproximateFilterSeries,
     scout_compute_api_NumericBucket as NumericBucket,
     scout_compute_api_NumericFilterTransformationSeries as NumericFilterTransformationSeries,
     scout_compute_api_NumericHistogramBucket as NumericHistogramBucket,

{nominal_api-0.547.0.dist-info → nominal_api-0.548.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nominal-api
-Version: 0.547.0
+Version: 0.548.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<3,>=2.8.0

{nominal_api-0.547.0.dist-info → nominal_api-0.548.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=ROwmqj2WeJmf321ogqk8N8qfv0l-JHMp_srM0GyX_yA,1762
-nominal_api/_impl.py,sha256=XvmduSleYQOhi1ggIoffdeSCkJKZKjdr6sN6o4d8t14,2669390
+nominal_api/__init__.py,sha256=DpiwteWk_axkvesrB3wC_kdhqkqOna7Y_0PLSksJbMM,1762
+nominal_api/_impl.py,sha256=WUA3AN68sL4wOVLPc0K7Uiup6QU-D756eV_8vR3Exak,2676840
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=mncavtSkHRCv-7xIkNkEX_XHnVgTPQwJyD6JDoaKwsQ,830
 nominal_api/api_rids/__init__.py,sha256=vLyAVUPTfk7u9D_K_7MHE-2Pf8leC5JxC-o8NrrnOPk,337
@@ -28,7 +28,7 @@ nominal_api/scout_checklistexecution_api/__init__.py,sha256=PfMFzie0xO5d5WSpB3bE
 nominal_api/scout_checks_api/__init__.py,sha256=RJH7HsXjUhItC11V9C-hfv6lkIfiSXyxnB8slUpaT2g,5203
 nominal_api/scout_comparisonnotebook_api/__init__.py,sha256=8BL5jE9NDxqCj9DyvZWSPhq6zw2J7xp6aLsl3x9rpyw,4530
 nominal_api/scout_comparisonrun_api/__init__.py,sha256=1LCXQe64tDqqeMQixW8PI-R_edSz7F5X0x2_ufEuC8M,480
-nominal_api/scout_compute_api/__init__.py,sha256=b4mLe0YgO7gJB9wcMryYm6KQ-8cWDrd7bXE75whzaWA,16256
+nominal_api/scout_compute_api/__init__.py,sha256=dPgSc95yeaIn8kTEd5Cw_ARB4XbVJdksMqG__bmmHDM,16508
 nominal_api/scout_compute_api_deprecated/__init__.py,sha256=RggSfc6C1VR1-kNXPWybpfw3hZbkQ1gvxEisFZCHdnM,3732
 nominal_api/scout_compute_representation_api/__init__.py,sha256=FezODo7sI8m6tDhPPK_gZX1qXImi4O3TUprDoNUuWpk,1672
 nominal_api/scout_compute_resolved_api/__init__.py,sha256=Lknm4GP9Bk5QrDt8N7q1KD7Xa82R8q4jZyHYxSPkIs4,8260
@@ -65,7 +65,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=wr83ByQTVVPOGvbB_KWL
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=YLixotb-W-adYR6t_RBsJDwoHttppkOBesoaXERwhVs,1240
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.547.0.dist-info/METADATA,sha256=hBKra3_PtTbg-sDFzMlPtbqjbkNP0oNSBmTW5G61fS0,199
-nominal_api-0.547.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-nominal_api-0.547.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.547.0.dist-info/RECORD,,
+nominal_api-0.548.0.dist-info/METADATA,sha256=TbkyIG2OxFOuuk3Hn7We-W5iVlImhKrIpBkMW3QuHyc,199
+nominal_api-0.548.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+nominal_api-0.548.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.548.0.dist-info/RECORD,,