nominal-api 0.1017.0__py3-none-any.whl → 0.1020.0__py3-none-any.whl

nominal_api/__init__.py

@@ -82,5 +82,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.1017.0"
+__version__ = "0.1020.0"
 

nominal_api/_impl.py

@@ -93476,6 +93476,37 @@ scout_video_api_VideoTimestampManifestVisitor.__qualname__ = "VideoTimestampMani
 scout_video_api_VideoTimestampManifestVisitor.__module__ = "nominal_api.scout_video_api"
 
 
+class scout_workbookcommon_api_AssetOffset(ConjureBeanType):
+    """An offset that can be applied to an asset.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'offset': ConjureFieldDefinition('offset', OptionalTypeWrapper[scout_workbookcommon_api_Offset]),
+            'data_sources': ConjureFieldDefinition('dataSources', OptionalTypeWrapper[Dict[scout_api_DataSourceRefName, scout_workbookcommon_api_Offset]])
+        }
+
+    __slots__: List[str] = ['_offset', '_data_sources']
+
+    def __init__(self, data_sources: Optional[Dict[str, "scout_workbookcommon_api_Offset"]] = None, offset: Optional["scout_workbookcommon_api_Offset"] = None) -> None:
+        self._offset = offset
+        self._data_sources = data_sources
+
+    @builtins.property
+    def offset(self) -> Optional["scout_workbookcommon_api_Offset"]:
+        return self._offset
+
+    @builtins.property
+    def data_sources(self) -> Optional[Dict[str, "scout_workbookcommon_api_Offset"]]:
+        return self._data_sources
+
+
+scout_workbookcommon_api_AssetOffset.__name__ = "AssetOffset"
+scout_workbookcommon_api_AssetOffset.__qualname__ = "AssetOffset"
+scout_workbookcommon_api_AssetOffset.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_AssetSettings(ConjureBeanType):
 
     @builtins.classmethod
@@ -93615,6 +93646,165 @@ scout_workbookcommon_api_InputTypeVisitor.__qualname__ = "InputTypeVisitor"
 scout_workbookcommon_api_InputTypeVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
 
 
+class scout_workbookcommon_api_Offset(ConjureUnionType):
+    _custom: Optional["scout_rids_api_UserDuration"] = None
+    _run_align: Optional["scout_workbookcommon_api_RunAlignment"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'custom': ConjureFieldDefinition('custom', scout_rids_api_UserDuration),
+            'run_align': ConjureFieldDefinition('runAlign', scout_workbookcommon_api_RunAlignment)
+        }
+
+    def __init__(
+            self,
+            custom: Optional["scout_rids_api_UserDuration"] = None,
+            run_align: Optional["scout_workbookcommon_api_RunAlignment"] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (custom is not None) + (run_align is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if custom is not None:
+                self._custom = custom
+                self._type = 'custom'
+            if run_align is not None:
+                self._run_align = run_align
+                self._type = 'runAlign'
+
+        elif type_of_union == 'custom':
+            if custom is None:
+                raise ValueError('a union value must not be None')
+            self._custom = custom
+            self._type = 'custom'
+        elif type_of_union == 'runAlign':
+            if run_align is None:
+                raise ValueError('a union value must not be None')
+            self._run_align = run_align
+            self._type = 'runAlign'
+
+    @builtins.property
+    def custom(self) -> Optional["scout_rids_api_UserDuration"]:
+        return self._custom
+
+    @builtins.property
+    def run_align(self) -> Optional["scout_workbookcommon_api_RunAlignment"]:
+        return self._run_align
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_workbookcommon_api_OffsetVisitor):
+            raise ValueError('{} is not an instance of scout_workbookcommon_api_OffsetVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'custom' and self.custom is not None:
+            return visitor._custom(self.custom)
+        if self._type == 'runAlign' and self.run_align is not None:
+            return visitor._run_align(self.run_align)
+
+
+scout_workbookcommon_api_Offset.__name__ = "Offset"
+scout_workbookcommon_api_Offset.__qualname__ = "Offset"
+scout_workbookcommon_api_Offset.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_OffsetVisitor:
+
+    @abstractmethod
+    def _custom(self, custom: "scout_rids_api_UserDuration") -> Any:
+        pass
+
+    @abstractmethod
+    def _run_align(self, run_align: "scout_workbookcommon_api_RunAlignment") -> Any:
+        pass
+
+
+scout_workbookcommon_api_OffsetVisitor.__name__ = "OffsetVisitor"
+scout_workbookcommon_api_OffsetVisitor.__qualname__ = "OffsetVisitor"
+scout_workbookcommon_api_OffsetVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_RunAlignTo(ConjureEnumType):
+    """The align to value for a run offset.
+    """
+
+    START = 'START'
+    '''START'''
+    END = 'END'
+    '''END'''
+    UNKNOWN = 'UNKNOWN'
+    '''UNKNOWN'''
+
+    def __reduce_ex__(self, proto):
+        return self.__class__, (self.name,)
+
+
+scout_workbookcommon_api_RunAlignTo.__name__ = "RunAlignTo"
+scout_workbookcommon_api_RunAlignTo.__qualname__ = "RunAlignTo"
+scout_workbookcommon_api_RunAlignTo.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_RunAlignment(ConjureBeanType):
+    """An offset that is defined relative to a target run.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'align_to': ConjureFieldDefinition('alignTo', scout_workbookcommon_api_RunAlignTo),
+            'target_run_rid': ConjureFieldDefinition('targetRunRid', scout_run_api_RunRid)
+        }
+
+    __slots__: List[str] = ['_align_to', '_target_run_rid']
+
+    def __init__(self, align_to: "scout_workbookcommon_api_RunAlignTo", target_run_rid: str) -> None:
+        self._align_to = align_to
+        self._target_run_rid = target_run_rid
+
+    @builtins.property
+    def align_to(self) -> "scout_workbookcommon_api_RunAlignTo":
+        return self._align_to
+
+    @builtins.property
+    def target_run_rid(self) -> str:
+        return self._target_run_rid
+
+
+scout_workbookcommon_api_RunAlignment.__name__ = "RunAlignment"
+scout_workbookcommon_api_RunAlignment.__qualname__ = "RunAlignment"
+scout_workbookcommon_api_RunAlignment.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_RunOffset(ConjureBeanType):
+    """An offset that can be applied to a run.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'offset': ConjureFieldDefinition('offset', OptionalTypeWrapper[scout_workbookcommon_api_Offset]),
+            'assets': ConjureFieldDefinition('assets', OptionalTypeWrapper[Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetOffset]])
+        }
+
+    __slots__: List[str] = ['_offset', '_assets']
+
+    def __init__(self, assets: Optional[Dict[str, "scout_workbookcommon_api_AssetOffset"]] = None, offset: Optional["scout_workbookcommon_api_Offset"] = None) -> None:
+        self._offset = offset
+        self._assets = assets
+
+    @builtins.property
+    def offset(self) -> Optional["scout_workbookcommon_api_Offset"]:
+        return self._offset
+
+    @builtins.property
+    def assets(self) -> Optional[Dict[str, "scout_workbookcommon_api_AssetOffset"]]:
+        return self._assets
+
+
+scout_workbookcommon_api_RunOffset.__name__ = "RunOffset"
+scout_workbookcommon_api_RunOffset.__qualname__ = "RunOffset"
+scout_workbookcommon_api_RunOffset.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_RunSettings(ConjureBeanType):
 
     @builtins.classmethod
@@ -94018,6 +94208,91 @@ scout_workbookcommon_api_WorkbookInputsV1.__qualname__ = "WorkbookInputsV1"
 scout_workbookcommon_api_WorkbookInputsV1.__module__ = "nominal_api.scout_workbookcommon_api"
 
 
+class scout_workbookcommon_api_WorkbookOffsets(ConjureUnionType):
+    _v1: Optional["scout_workbookcommon_api_WorkbookOffsetsV1"] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'v1': ConjureFieldDefinition('v1', scout_workbookcommon_api_WorkbookOffsetsV1)
+        }
+
+    def __init__(
+            self,
+            v1: Optional["scout_workbookcommon_api_WorkbookOffsetsV1"] = 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_WorkbookOffsetsV1"]:
+        return self._v1
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, scout_workbookcommon_api_WorkbookOffsetsVisitor):
+            raise ValueError('{} is not an instance of scout_workbookcommon_api_WorkbookOffsetsVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'v1' and self.v1 is not None:
+            return visitor._v1(self.v1)
+
+
+scout_workbookcommon_api_WorkbookOffsets.__name__ = "WorkbookOffsets"
+scout_workbookcommon_api_WorkbookOffsets.__qualname__ = "WorkbookOffsets"
+scout_workbookcommon_api_WorkbookOffsets.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_WorkbookOffsetsVisitor:
+
+    @abstractmethod
+    def _v1(self, v1: "scout_workbookcommon_api_WorkbookOffsetsV1") -> Any:
+        pass
+
+
+scout_workbookcommon_api_WorkbookOffsetsVisitor.__name__ = "WorkbookOffsetsVisitor"
+scout_workbookcommon_api_WorkbookOffsetsVisitor.__qualname__ = "WorkbookOffsetsVisitor"
+scout_workbookcommon_api_WorkbookOffsetsVisitor.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
+class scout_workbookcommon_api_WorkbookOffsetsV1(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'runs': ConjureFieldDefinition('runs', Dict[scout_run_api_RunRid, scout_workbookcommon_api_RunOffset]),
+            'assets': ConjureFieldDefinition('assets', Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetOffset])
+        }
+
+    __slots__: List[str] = ['_runs', '_assets']
+
+    def __init__(self, assets: Dict[str, "scout_workbookcommon_api_AssetOffset"], runs: Dict[str, "scout_workbookcommon_api_RunOffset"]) -> None:
+        self._runs = runs
+        self._assets = assets
+
+    @builtins.property
+    def runs(self) -> Dict[str, "scout_workbookcommon_api_RunOffset"]:
+        return self._runs
+
+    @builtins.property
+    def assets(self) -> Dict[str, "scout_workbookcommon_api_AssetOffset"]:
+        return self._assets
+
+
+scout_workbookcommon_api_WorkbookOffsetsV1.__name__ = "WorkbookOffsetsV1"
+scout_workbookcommon_api_WorkbookOffsetsV1.__qualname__ = "WorkbookOffsetsV1"
+scout_workbookcommon_api_WorkbookOffsetsV1.__module__ = "nominal_api.scout_workbookcommon_api"
+
+
 class scout_workbookcommon_api_WorkbookSettings(ConjureBeanType):
 
     @builtins.classmethod
@@ -94025,15 +94300,17 @@ class scout_workbookcommon_api_WorkbookSettings(ConjureBeanType):
         return {
             'asset_settings': ConjureFieldDefinition('assetSettings', OptionalTypeWrapper[Dict[scout_rids_api_AssetRid, scout_workbookcommon_api_AssetSettings]]),
             'run_settings': ConjureFieldDefinition('runSettings', OptionalTypeWrapper[Dict[scout_run_api_RunRid, scout_workbookcommon_api_RunSettings]]),
-            'time_settings': ConjureFieldDefinition('timeSettings', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookTimeSettings])
+            'time_settings': ConjureFieldDefinition('timeSettings', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookTimeSettings]),
+            'offsets': ConjureFieldDefinition('offsets', OptionalTypeWrapper[scout_workbookcommon_api_WorkbookOffsets])
         }
 
-    __slots__: List[str] = ['_asset_settings', '_run_settings', '_time_settings']
+    __slots__: List[str] = ['_asset_settings', '_run_settings', '_time_settings', '_offsets']
 
-    def __init__(self, asset_settings: Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]] = None, run_settings: Optional[Dict[str, "scout_workbookcommon_api_RunSettings"]] = None, time_settings: Optional["scout_workbookcommon_api_WorkbookTimeSettings"] = None) -> None:
+    def __init__(self, asset_settings: Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]] = None, offsets: Optional["scout_workbookcommon_api_WorkbookOffsets"] = None, run_settings: Optional[Dict[str, "scout_workbookcommon_api_RunSettings"]] = None, time_settings: Optional["scout_workbookcommon_api_WorkbookTimeSettings"] = None) -> None:
         self._asset_settings = asset_settings
         self._run_settings = run_settings
         self._time_settings = time_settings
+        self._offsets = offsets
 
     @builtins.property
     def asset_settings(self) -> Optional[Dict[str, "scout_workbookcommon_api_AssetSettings"]]:
@@ -94054,6 +94331,12 @@ over persisted the global time range.
         """
         return self._time_settings
 
+    @builtins.property
+    def offsets(self) -> Optional["scout_workbookcommon_api_WorkbookOffsets"]:
+        """Time offsets that can be applied to the workbook.
+        """
+        return self._offsets
+
 
 scout_workbookcommon_api_WorkbookSettings.__name__ = "WorkbookSettings"
 scout_workbookcommon_api_WorkbookSettings.__qualname__ = "WorkbookSettings"