nominal-api 0.825.1__py3-none-any.whl → 0.826.0__py3-none-any.whl

nominal_api/__init__.py

@@ -80,5 +80,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.825.1"
+__version__ = "0.826.0"
 

nominal_api/_impl.py

@@ -83390,6 +83390,193 @@ scout_workbookcommon_api_EventReference.__qualname__ = "EventReference"
 scout_workbookcommon_api_EventReference.__module__ = "nominal_api.scout_workbookcommon_api"
 
 
+class scout_workbookcommon_api_InputType(ConjureUnionType):
+    _tag: Optional["scout_workbookcommon_api_Tag"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'tag': ConjureFieldDefinition('tag', scout_workbookcommon_api_Tag)
+        }
+
+    def __init__(
+            self,
+            tag: Optional["scout_workbookcommon_api_Tag"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (tag is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if tag is not None:
+                self._tag = tag
+                self._type = 'tag'
+
+        elif type_of_union == 'tag':
+            if tag is None:
+                raise ValueError('a union value must not be None')
+            self._tag = tag
+            self._type = 'tag'
+
+    @builtins.property
+    def tag(self) -> Optional["scout_workbookcommon_api_Tag"]:
+        return self._tag
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_workbookcommon_api_InputTypeVisitor):
+            raise ValueError('{} is not an instance of scout_workbookcommon_api_InputTypeVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'tag' and self.tag is not None:
+            return visitor._tag(self.tag)
+
+
+scout_workbookcommon_api_InputType.__name__ = "InputType"
+scout_workbookcommon_api_InputType.__qualname__ = "InputType"
+scout_workbookcommon_api_InputType.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_InputTypeVisitor:
+
+    @abstractmethod
+    def _tag(self, tag: "scout_workbookcommon_api_Tag") -> Any:
+        pass
+
+
+scout_workbookcommon_api_InputTypeVisitor.__name__ = "InputTypeVisitor"
+scout_workbookcommon_api_InputTypeVisitor.__qualname__ = "InputTypeVisitor"
+scout_workbookcommon_api_InputTypeVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_Tag(ConjureBeanType):
+    """A tag input contains tag key and tag value information that can apply
+to a channel's compute tree. Applies the tag to both the tag filter
+and tag group by fields of the series node in the compute tree.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'key': ConjureFieldDefinition('key', scout_workbookcommon_api_TagString),
+            'values': ConjureFieldDefinition('values', List[scout_workbookcommon_api_TagString])
+        }
+
+    __slots__: List[str] = ['_key', '_values']
+
+    def __init__(self, key: "scout_workbookcommon_api_TagString", values: List["scout_workbookcommon_api_TagString"]) -> None:
+        self._key = key
+        self._values = values
+
+    @builtins.property
+    def key(self) -> "scout_workbookcommon_api_TagString":
+        """The key of the tag for the filter and group by compute arguments.
+        """
+        return self._key
+
+    @builtins.property
+    def values(self) -> List["scout_workbookcommon_api_TagString"]:
+        """The values of the tag to filter against. 
+An empty list will treat the tag as a wildcard, including all values in the compute
+        """
+        return self._values
+
+
+scout_workbookcommon_api_Tag.__name__ = "Tag"
+scout_workbookcommon_api_Tag.__qualname__ = "Tag"
+scout_workbookcommon_api_Tag.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_TagString(ConjureUnionType):
+    _literal: Optional["scout_workbookcommon_api_TagStringLiteral"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'literal': ConjureFieldDefinition('literal', scout_workbookcommon_api_TagStringLiteral)
+        }
+
+    def __init__(
+            self,
+            literal: Optional["scout_workbookcommon_api_TagStringLiteral"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (literal is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if literal is not None:
+                self._literal = literal
+                self._type = 'literal'
+
+        elif type_of_union == 'literal':
+            if literal is None:
+                raise ValueError('a union value must not be None')
+            self._literal = literal
+            self._type = 'literal'
+
+    @builtins.property
+    def literal(self) -> Optional["scout_workbookcommon_api_TagStringLiteral"]:
+        return self._literal
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_workbookcommon_api_TagStringVisitor):
+            raise ValueError('{} is not an instance of scout_workbookcommon_api_TagStringVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'literal' and self.literal is not None:
+            return visitor._literal(self.literal)
+
+
+scout_workbookcommon_api_TagString.__name__ = "TagString"
+scout_workbookcommon_api_TagString.__qualname__ = "TagString"
+scout_workbookcommon_api_TagString.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_TagStringVisitor:
+
+    @abstractmethod
+    def _literal(self, literal: "scout_workbookcommon_api_TagStringLiteral") -> Any:
+        pass
+
+
+scout_workbookcommon_api_TagStringVisitor.__name__ = "TagStringVisitor"
+scout_workbookcommon_api_TagStringVisitor.__qualname__ = "TagStringVisitor"
+scout_workbookcommon_api_TagStringVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_TagStringLiteral(ConjureBeanType):
+    """A literal string value
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'id': ConjureFieldDefinition('id', str),
+            'value': ConjureFieldDefinition('value', str)
+        }
+
+    __slots__: List[str] = ['_id', '_value']
+
+    def __init__(self, id: str, value: str) -> None:
+        self._id = id
+        self._value = value
+
+    @builtins.property
+    def id(self) -> str:
+        """A unique identifier for this string. Cannot be shared across different Tag inputs.
+Used as the variable id for the StringConstant applied to the tag fields 
+of the channel compute node.
+        """
+        return self._id
+
+    @builtins.property
+    def value(self) -> str:
+        """The string value.
+        """
+        return self._value
+
+
+scout_workbookcommon_api_TagStringLiteral.__name__ = "TagStringLiteral"
+scout_workbookcommon_api_TagStringLiteral.__qualname__ = "TagStringLiteral"
+scout_workbookcommon_api_TagStringLiteral.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_UnifiedWorkbookContent(ConjureUnionType):
     _workbook: Optional["scout_workbookcommon_api_WorkbookContent"] = None
     _comparison_workbook: Optional["scout_comparisonnotebook_api_ComparisonWorkbookContent"] = None
@@ -83473,14 +83660,16 @@ class scout_workbookcommon_api_WorkbookContent(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'channel_variables': ConjureFieldDefinition('channelVariables', scout_channelvariables_api_WorkbookChannelVariableMap),
+            'inputs': ConjureFieldDefinition('inputs', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookInputs]),
             'charts': ConjureFieldDefinition('charts', scout_chartdefinition_api_WorkbookVizDefinitionMap),
             'settings': ConjureFieldDefinition('settings', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookSettings])
         }
 
-    __slots__: List[str] = ['_channel_variables', '_charts', '_settings']
+    __slots__: List[str] = ['_channel_variables', '_inputs', '_charts', '_settings']
 
-    def __init__(self, channel_variables: Dict[str, "scout_channelvariables_api_ChannelVariable"], charts: Dict[str, "scout_chartdefinition_api_VizDefinition"], settings: Optional["scout_workbookcommon_api_WorkbookSettings"] = None) -> None:
+    def __init__(self, channel_variables: Dict[str, "scout_channelvariables_api_ChannelVariable"], charts: Dict[str, "scout_chartdefinition_api_VizDefinition"], inputs: Optional["scout_workbookcommon_api_WorkbookInputs"] = None, settings: Optional["scout_workbookcommon_api_WorkbookSettings"] = None) -> None:
         self._channel_variables = channel_variables
+        self._inputs = inputs
         self._charts = charts
         self._settings = settings
 
@@ -83488,6 +83677,10 @@ class scout_workbookcommon_api_WorkbookContent(ConjureBeanType):
     def channel_variables(self) -> Dict[str, "scout_channelvariables_api_ChannelVariable"]:
         return self._channel_variables
 
+    @builtins.property
+    def inputs(self) -> Optional["scout_workbookcommon_api_WorkbookInputs"]:
+        return self._inputs
+
     @builtins.property
     def charts(self) -> Dict[str, "scout_chartdefinition_api_VizDefinition"]:
         """map of visualizations. Previously termed "charts"
@@ -83504,6 +83697,129 @@ scout_workbookcommon_api_WorkbookContent.__qualname__ = "WorkbookContent"
 scout_workbookcommon_api_WorkbookContent.__module__ = "nominal_api.scout_workbookcommon_api"
 
 
+class scout_workbookcommon_api_WorkbookInput(ConjureBeanType):
+    """A workbook input is a value managed at the workbook level
+that can be applied to multiple elements.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'id': ConjureFieldDefinition('id', str),
+            'label': ConjureFieldDefinition('label', OptionalTypeWrapper[str]),
+            'value': ConjureFieldDefinition('value', scout_workbookcommon_api_InputType)
+        }
+
+    __slots__: List[str] = ['_id', '_label', '_value']
+
+    def __init__(self, id: str, value: "scout_workbookcommon_api_InputType", label: Optional[str] = None) -> None:
+        self._id = id
+        self._label = label
+        self._value = value
+
+    @builtins.property
+    def id(self) -> str:
+        """The unique identifier of the input.
+        """
+        return self._id
+
+    @builtins.property
+    def label(self) -> Optional[str]:
+        """The label of the input for display purposes.
+        """
+        return self._label
+
+    @builtins.property
+    def value(self) -> "scout_workbookcommon_api_InputType":
+        return self._value
+
+
+scout_workbookcommon_api_WorkbookInput.__name__ = "WorkbookInput"
+scout_workbookcommon_api_WorkbookInput.__qualname__ = "WorkbookInput"
+scout_workbookcommon_api_WorkbookInput.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_WorkbookInputs(ConjureUnionType):
+    _v1: Optional["scout_workbookcommon_api_WorkbookInputsV1"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'v1': ConjureFieldDefinition('v1', scout_workbookcommon_api_WorkbookInputsV1)
+        }
+
+    def __init__(
+            self,
+            v1: Optional["scout_workbookcommon_api_WorkbookInputsV1"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (v1 is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if v1 is not None:
+                self._v1 = v1
+                self._type = 'v1'
+
+        elif type_of_union == 'v1':
+            if v1 is None:
+                raise ValueError('a union value must not be None')
+            self._v1 = v1
+            self._type = 'v1'
+
+    @builtins.property
+    def v1(self) -> Optional["scout_workbookcommon_api_WorkbookInputsV1"]:
+        return self._v1
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_workbookcommon_api_WorkbookInputsVisitor):
+            raise ValueError('{} is not an instance of scout_workbookcommon_api_WorkbookInputsVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'v1' and self.v1 is not None:
+            return visitor._v1(self.v1)
+
+
+scout_workbookcommon_api_WorkbookInputs.__name__ = "WorkbookInputs"
+scout_workbookcommon_api_WorkbookInputs.__qualname__ = "WorkbookInputs"
+scout_workbookcommon_api_WorkbookInputs.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_WorkbookInputsVisitor:
+
+    @abstractmethod
+    def _v1(self, v1: "scout_workbookcommon_api_WorkbookInputsV1") -> Any:
+        pass
+
+
+scout_workbookcommon_api_WorkbookInputsVisitor.__name__ = "WorkbookInputsVisitor"
+scout_workbookcommon_api_WorkbookInputsVisitor.__qualname__ = "WorkbookInputsVisitor"
+scout_workbookcommon_api_WorkbookInputsVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_WorkbookInputsV1(ConjureBeanType):
+    """A list of workbook inputs.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'inputs': ConjureFieldDefinition('inputs', List[scout_workbookcommon_api_WorkbookInput])
+        }
+
+    __slots__: List[str] = ['_inputs']
+
+    def __init__(self, inputs: List["scout_workbookcommon_api_WorkbookInput"]) -> None:
+        self._inputs = inputs
+
+    @builtins.property
+    def inputs(self) -> List["scout_workbookcommon_api_WorkbookInput"]:
+        return self._inputs
+
+
+scout_workbookcommon_api_WorkbookInputsV1.__name__ = "WorkbookInputsV1"
+scout_workbookcommon_api_WorkbookInputsV1.__qualname__ = "WorkbookInputsV1"
+scout_workbookcommon_api_WorkbookInputsV1.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_WorkbookSettings(ConjureBeanType):
 
     @builtins.classmethod

nominal_api/scout_workbookcommon_api/__init__.py

@@ -3,9 +3,19 @@ from .._impl import (
     scout_workbookcommon_api_AssetSettings as AssetSettings,
     scout_workbookcommon_api_CheckAlertReference as CheckAlertReference,
     scout_workbookcommon_api_EventReference as EventReference,
+    scout_workbookcommon_api_InputType as InputType,
+    scout_workbookcommon_api_InputTypeVisitor as InputTypeVisitor,
+    scout_workbookcommon_api_Tag as Tag,
+    scout_workbookcommon_api_TagString as TagString,
+    scout_workbookcommon_api_TagStringLiteral as TagStringLiteral,
+    scout_workbookcommon_api_TagStringVisitor as TagStringVisitor,
     scout_workbookcommon_api_UnifiedWorkbookContent as UnifiedWorkbookContent,
     scout_workbookcommon_api_UnifiedWorkbookContentVisitor as UnifiedWorkbookContentVisitor,
     scout_workbookcommon_api_WorkbookContent as WorkbookContent,
+    scout_workbookcommon_api_WorkbookInput as WorkbookInput,
+    scout_workbookcommon_api_WorkbookInputs as WorkbookInputs,
+    scout_workbookcommon_api_WorkbookInputsV1 as WorkbookInputsV1,
+    scout_workbookcommon_api_WorkbookInputsVisitor as WorkbookInputsVisitor,
     scout_workbookcommon_api_WorkbookSettings as WorkbookSettings,
 )
 
@@ -13,9 +23,19 @@ __all__ = [
     'AssetSettings',
     'CheckAlertReference',
     'EventReference',
+    'InputType',
+    'InputTypeVisitor',
+    'Tag',
+    'TagString',
+    'TagStringVisitor',
+    'TagStringLiteral',
     'UnifiedWorkbookContent',
     'UnifiedWorkbookContentVisitor',
     'WorkbookContent',
+    'WorkbookInput',
+    'WorkbookInputs',
+    'WorkbookInputsVisitor',
+    'WorkbookInputsV1',
     'WorkbookSettings',
 ]
 

{nominal_api-0.825.1.dist-info → nominal_api-0.826.0.dist-info}/METADATA

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

{nominal_api-0.825.1.dist-info → nominal_api-0.826.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=AS1hnAa7EariLYafbwqKihLNiSNDbW9OOzKz6GOimvo,2064
-nominal_api/_impl.py,sha256=8wDte-4n1YClGFV40BykYeo-tJ0nu3-QbkpWRubl-40,3602765
+nominal_api/__init__.py,sha256=XPgFLo5hOLGgqTQBT1mRRuGjmb0F5h4Vp40WtkS9ITI,2064
+nominal_api/_impl.py,sha256=J8OsB4SaJGK-XQWTmat-S1vB7BcOc86yIFu406qdm-Q,3614172
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=ZiGjcYwIBCrZR5pPqyqX2ggRJmVcSlOCazMtF2xCZzw,2171
 nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -60,7 +60,7 @@ nominal_api/scout_units_api/__init__.py,sha256=gf47pW6JIcP3FgL1UuHwkibj266FCRszL
 nominal_api/scout_versioning_api/__init__.py,sha256=AGSj6Gd1gDUnY3BTpXhPkEzCnrKIMfvs3S17m68HGfQ,1822
 nominal_api/scout_video/__init__.py,sha256=orm_3BDcBo2LaSHAf2lwO1vN4OX2oHwTI1QTTvF_pgE,286
 nominal_api/scout_video_api/__init__.py,sha256=kW6Tc4bHePsivAVb_i8tukohd7LkWyzPJKgsuBnCDpk,5628
-nominal_api/scout_workbookcommon_api/__init__.py,sha256=53f5wXBvk8TnnxssuGTl0wggHS8DzqD0sB-TU9Wi6Ng,740
+nominal_api/scout_workbookcommon_api/__init__.py,sha256=bFSGQ26a--qgaD_JbHDz0LtrY8TuMwKXXbY5I8HoSzo,1569
 nominal_api/secrets_api/__init__.py,sha256=orauwNcjFEmZnIrx4Zos0oALO-RiczeRdlSXrWSsCno,1060
 nominal_api/security_api_workspace/__init__.py,sha256=ZFzrThMO0IDhajFC6fpp_giLx1LjTHuZbY-3sTFpX9I,1536
 nominal_api/storage_datasource_api/__init__.py,sha256=plSbtDZH_wwfUNUzK8E1TauvfmvlCgn85U0NbNhmVZo,620
@@ -77,7 +77,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=BwdqHLq_98LOsRV14JA3
 nominal_api/timeseries_seriescache/__init__.py,sha256=hL5hN8jKLEGE_fDiZzdASmWIrRjU6tncpmDeuc_47P4,150
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=USBxFmNnVFdnhTPLvWi3UgsvBZ4Iz4ycNgBTi10F-zI,1603
 nominal_api/upload_api/__init__.py,sha256=7-XXuZUqKPV4AMWvxNpZPZ5vBun4x-AomXj3Vol_BN4,123
-nominal_api-0.825.1.dist-info/METADATA,sha256=1oufg3Hbv9f52ydpLORz_sVz91qBmbJ9gpvyV6nyxD8,199
-nominal_api-0.825.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.825.1.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.825.1.dist-info/RECORD,,
+nominal_api-0.826.0.dist-info/METADATA,sha256=RoYfR_mSJ_-mE-8E_gez6eZxE_JJvAK_rP36cftnsvY,199
+nominal_api-0.826.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.826.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.826.0.dist-info/RECORD,,