nominal-api 0.766.0__tar.gz → 0.768.0__tar.gz

{nominal_api-0.766.0 → nominal_api-0.768.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.766.0
+Version: 0.768.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<4,>=2.8.0

{nominal_api-0.766.0 → nominal_api-0.768.0}/nominal_api/__init__.py

@@ -78,5 +78,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.766.0"
+__version__ = "0.768.0"
 

{nominal_api-0.766.0 → nominal_api-0.768.0}/nominal_api/_impl.py

@@ -41952,6 +41952,65 @@ scout_compute_api_DerivativeSeries.__qualname__ = "DerivativeSeries"
 scout_compute_api_DerivativeSeries.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_DerivedSeries(ConjureUnionType):
+    """Represents a derived series within a compute graph.
+This is a series that is derived from a function within a module.
+    """
+    _module_application: Optional["scout_compute_api_ModuleApplicationDerivedSeries"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'module_application': ConjureFieldDefinition('moduleApplication', scout_compute_api_ModuleApplicationDerivedSeries)
+        }
+
+    def __init__(
+            self,
+            module_application: Optional["scout_compute_api_ModuleApplicationDerivedSeries"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (module_application is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if module_application is not None:
+                self._module_application = module_application
+                self._type = 'moduleApplication'
+
+        elif type_of_union == 'moduleApplication':
+            if module_application is None:
+                raise ValueError('a union value must not be None')
+            self._module_application = module_application
+            self._type = 'moduleApplication'
+
+    @builtins.property
+    def module_application(self) -> Optional["scout_compute_api_ModuleApplicationDerivedSeries"]:
+        return self._module_application
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_compute_api_DerivedSeriesVisitor):
+            raise ValueError('{} is not an instance of scout_compute_api_DerivedSeriesVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'moduleApplication' and self.module_application is not None:
+            return visitor._module_application(self.module_application)
+
+
+scout_compute_api_DerivedSeries.__name__ = "DerivedSeries"
+scout_compute_api_DerivedSeries.__qualname__ = "DerivedSeries"
+scout_compute_api_DerivedSeries.__module__ = "nominal_api.scout_compute_api"
+
+
+class scout_compute_api_DerivedSeriesVisitor:
+
+    @abstractmethod
+    def _module_application(self, module_application: "scout_compute_api_ModuleApplicationDerivedSeries") -> Any:
+        pass
+
+
+scout_compute_api_DerivedSeriesVisitor.__name__ = "DerivedSeriesVisitor"
+scout_compute_api_DerivedSeriesVisitor.__qualname__ = "DerivedSeriesVisitor"
+scout_compute_api_DerivedSeriesVisitor.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_DoubleConstant(ConjureUnionType):
     _literal: Optional[float] = None
     _variable: Optional[str] = None
@@ -44967,6 +45026,49 @@ scout_compute_api_Minimum.__qualname__ = "Minimum"
 scout_compute_api_Minimum.__module__ = "nominal_api.scout_compute_api"
 
 
+class scout_compute_api_ModuleApplicationDerivedSeries(ConjureBeanType):
+    """A reference to a derived series resulting from applying a module to an asset.
+The referenced module must be applied to the referenced asset.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'module_application_rid': ConjureFieldDefinition('moduleApplicationRid', scout_compute_api_StringConstant),
+            'function_name': ConjureFieldDefinition('functionName', scout_compute_api_StringConstant),
+            'function_args': ConjureFieldDefinition('functionArgs', Dict[scout_compute_api_VariableName, scout_compute_api_VariableValue])
+        }
+
+    __slots__: List[str] = ['_module_application_rid', '_function_name', '_function_args']
+
+    def __init__(self, function_args: Dict[str, "scout_compute_api_VariableValue"], function_name: "scout_compute_api_StringConstant", module_application_rid: "scout_compute_api_StringConstant") -> None:
+        self._module_application_rid = module_application_rid
+        self._function_name = function_name
+        self._function_args = function_args
+
+    @builtins.property
+    def module_application_rid(self) -> "scout_compute_api_StringConstant":
+        """A reference to the module application that produced this derived series.
+        """
+        return self._module_application_rid
+
+    @builtins.property
+    def function_name(self) -> "scout_compute_api_StringConstant":
+        return self._function_name
+
+    @builtins.property
+    def function_args(self) -> Dict[str, "scout_compute_api_VariableValue"]:
+        """Map of function input names to their values. The function inputs must match the function's parameter
+names and types. Because all function parameters have default values when the module is applied to the asset, this can be empty.
+        """
+        return self._function_args
+
+
+scout_compute_api_ModuleApplicationDerivedSeries.__name__ = "ModuleApplicationDerivedSeries"
+scout_compute_api_ModuleApplicationDerivedSeries.__qualname__ = "ModuleApplicationDerivedSeries"
+scout_compute_api_ModuleApplicationDerivedSeries.__module__ = "nominal_api.scout_compute_api"
+
+
 class scout_compute_api_NegativeValueConfiguration(ConjureUnionType):
     _allow_negative_values: Optional["scout_compute_api_AllowNegativeValues"] = None
     _set_negative_values_to_zero: Optional["scout_compute_api_SetNegativeValuesToZero"] = None
@@ -51172,6 +51274,7 @@ class scout_compute_api_VariableValue(ConjureUnionType):
     _duration: Optional["scout_run_api_Duration"] = None
     _integer: Optional[int] = None
     _channel: Optional["scout_compute_api_ChannelSeries"] = None
+    _derived: Optional["scout_compute_api_DerivedSeries"] = None
     _series: Optional["scout_compute_api_SeriesSpec"] = None
     _string: Optional[str] = None
     _string_set: Optional[List[str]] = None
@@ -51185,6 +51288,7 @@ class scout_compute_api_VariableValue(ConjureUnionType):
             'duration': ConjureFieldDefinition('duration', scout_run_api_Duration),
             'integer': ConjureFieldDefinition('integer', int),
             'channel': ConjureFieldDefinition('channel', scout_compute_api_ChannelSeries),
+            'derived': ConjureFieldDefinition('derived', scout_compute_api_DerivedSeries),
             'series': ConjureFieldDefinition('series', scout_compute_api_SeriesSpec),
             'string': ConjureFieldDefinition('string', str),
             'string_set': ConjureFieldDefinition('stringSet', List[str]),
@@ -51198,6 +51302,7 @@ class scout_compute_api_VariableValue(ConjureUnionType):
             duration: Optional["scout_run_api_Duration"] = None,
             integer: Optional[int] = None,
             channel: Optional["scout_compute_api_ChannelSeries"] = None,
+            derived: Optional["scout_compute_api_DerivedSeries"] = None,
             series: Optional["scout_compute_api_SeriesSpec"] = None,
             string: Optional[str] = None,
             string_set: Optional[List[str]] = None,
@@ -51205,7 +51310,7 @@ class scout_compute_api_VariableValue(ConjureUnionType):
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (double is not None) + (compute_node is not None) + (duration is not None) + (integer is not None) + (channel is not None) + (series is not None) + (string is not None) + (string_set is not None) + (timestamp is not None) != 1:
+            if (double is not None) + (compute_node is not None) + (duration is not None) + (integer is not None) + (channel is not None) + (derived is not None) + (series is not None) + (string is not None) + (string_set is not None) + (timestamp is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if double is not None:
@@ -51223,6 +51328,9 @@ class scout_compute_api_VariableValue(ConjureUnionType):
             if channel is not None:
                 self._channel = channel
                 self._type = 'channel'
+            if derived is not None:
+                self._derived = derived
+                self._type = 'derived'
             if series is not None:
                 self._series = series
                 self._type = 'series'
@@ -51261,6 +51369,11 @@ class scout_compute_api_VariableValue(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._channel = channel
             self._type = 'channel'
+        elif type_of_union == 'derived':
+            if derived is None:
+                raise ValueError('a union value must not be None')
+            self._derived = derived
+            self._type = 'derived'
         elif type_of_union == 'series':
             if series is None:
                 raise ValueError('a union value must not be None')
@@ -51302,6 +51415,10 @@ class scout_compute_api_VariableValue(ConjureUnionType):
     def channel(self) -> Optional["scout_compute_api_ChannelSeries"]:
         return self._channel
 
+    @builtins.property
+    def derived(self) -> Optional["scout_compute_api_DerivedSeries"]:
+        return self._derived
+
     @builtins.property
     def series(self) -> Optional["scout_compute_api_SeriesSpec"]:
         return self._series
@@ -51331,6 +51448,8 @@ class scout_compute_api_VariableValue(ConjureUnionType):
             return visitor._integer(self.integer)
         if self._type == 'channel' and self.channel is not None:
             return visitor._channel(self.channel)
+        if self._type == 'derived' and self.derived is not None:
+            return visitor._derived(self.derived)
         if self._type == 'series' and self.series is not None:
             return visitor._series(self.series)
         if self._type == 'string' and self.string is not None:
@@ -51368,6 +51487,10 @@ class scout_compute_api_VariableValueVisitor:
     def _channel(self, channel: "scout_compute_api_ChannelSeries") -> Any:
         pass
 
+    @abstractmethod
+    def _derived(self, derived: "scout_compute_api_DerivedSeries") -> Any:
+        pass
+
     @abstractmethod
     def _series(self, series: "scout_compute_api_SeriesSpec") -> Any:
         pass

{nominal_api-0.766.0 → nominal_api-0.768.0}/nominal_api/scout_compute_api/__init__.py

@@ -95,6 +95,8 @@ from .._impl import (
     scout_compute_api_DecimateWithBuckets as DecimateWithBuckets,
     scout_compute_api_DecimateWithResolution as DecimateWithResolution,
     scout_compute_api_DerivativeSeries as DerivativeSeries,
+    scout_compute_api_DerivedSeries as DerivedSeries,
+    scout_compute_api_DerivedSeriesVisitor as DerivedSeriesVisitor,
     scout_compute_api_DoubleConstant as DoubleConstant,
     scout_compute_api_DoubleConstantVisitor as DoubleConstantVisitor,
     scout_compute_api_DriverSeries3d as DriverSeries3d,
@@ -191,6 +193,7 @@ from .._impl import (
     scout_compute_api_MinMaxThresholdRanges as MinMaxThresholdRanges,
     scout_compute_api_MinSeries as MinSeries,
     scout_compute_api_Minimum as Minimum,
+    scout_compute_api_ModuleApplicationDerivedSeries as ModuleApplicationDerivedSeries,
     scout_compute_api_NegativeValueConfiguration as NegativeValueConfiguration,
     scout_compute_api_NegativeValueConfigurationVisitor as NegativeValueConfigurationVisitor,
     scout_compute_api_NotRanges as NotRanges,
@@ -432,6 +435,8 @@ __all__ = [
     'DecimateWithBuckets',
     'DecimateWithResolution',
     'DerivativeSeries',
+    'DerivedSeries',
+    'DerivedSeriesVisitor',
     'DoubleConstant',
     'DoubleConstantVisitor',
     'DriverSeries3d',
@@ -528,6 +533,7 @@ __all__ = [
     'MinMaxThresholdRanges',
     'MinSeries',
     'Minimum',
+    'ModuleApplicationDerivedSeries',
     'NegativeValueConfiguration',
     'NegativeValueConfigurationVisitor',
     'NotRanges',

{nominal_api-0.766.0 → nominal_api-0.768.0}/nominal_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nominal-api
-Version: 0.766.0
+Version: 0.768.0
 Requires-Python: >=3.8
 Requires-Dist: requests
 Requires-Dist: conjure-python-client<4,>=2.8.0

{nominal_api-0.766.0 → nominal_api-0.768.0}/setup.py

@@ -6,7 +6,7 @@ from setuptools import (
 
 setup(
     name='nominal-api',
-    version='0.766.0',
+    version='0.768.0',
     python_requires='>=3.8',
     package_data={"": ["py.typed"]},
     packages=find_packages(),