nominal-api 0.759.0__py3-none-any.whl → 0.761.0__py3-none-any.whl

nominal_api/__init__.py

@@ -17,6 +17,7 @@ __all__ = [
     'ingest_api',
     'ingest_workflow_api',
     'module',
+    'module_internal',
     'modules_api',
     'persistent_compute_api',
     'scout',
@@ -77,5 +78,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.759.0"
+__version__ = "0.761.0"
 

nominal_api/_impl.py

@@ -9192,6 +9192,8 @@ class ingest_api_FileOutputFormat(ConjureEnumType):
     '''PARQUET_TAR'''
     AVRO_STREAM = 'AVRO_STREAM'
     '''AVRO_STREAM'''
+    JSON_L = 'JSON_L'
+    '''JSON_L'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 
@@ -14213,15 +14215,17 @@ class module_CreateModuleRequest(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'name': ConjureFieldDefinition('name', str),
+            'title': ConjureFieldDefinition('title', str),
             'description': ConjureFieldDefinition('description', str),
             'definition': ConjureFieldDefinition('definition', module_ModuleVersionDefinition),
             'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_rids_WorkspaceRid])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_definition', '_workspace']
+    __slots__: List[str] = ['_name', '_title', '_description', '_definition', '_workspace']
 
-    def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str, workspace: Optional[str] = None) -> None:
+    def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str, title: str, workspace: Optional[str] = None) -> None:
         self._name = name
+        self._title = title
         self._description = description
         self._definition = definition
         self._workspace = workspace
@@ -14232,6 +14236,10 @@ class module_CreateModuleRequest(ConjureBeanType):
         """
         return self._name
 
+    @builtins.property
+    def title(self) -> str:
+        return self._title
+
     @builtins.property
     def description(self) -> str:
         return self._description
@@ -14668,17 +14676,19 @@ class module_ModuleMetadata(ConjureBeanType):
         return {
             'rid': ConjureFieldDefinition('rid', modules_api_ModuleRid),
             'name': ConjureFieldDefinition('name', str),
+            'title': ConjureFieldDefinition('title', str),
             'description': ConjureFieldDefinition('description', str),
             'created_by': ConjureFieldDefinition('createdBy', scout_rids_api_UserRid),
             'created_at': ConjureFieldDefinition('createdAt', str),
             'archived_at': ConjureFieldDefinition('archivedAt', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_rid', '_name', '_description', '_created_by', '_created_at', '_archived_at']
+    __slots__: List[str] = ['_rid', '_name', '_title', '_description', '_created_by', '_created_at', '_archived_at']
 
-    def __init__(self, created_at: str, created_by: str, description: str, name: str, rid: str, archived_at: Optional[str] = None) -> None:
+    def __init__(self, created_at: str, created_by: str, description: str, name: str, rid: str, title: str, archived_at: Optional[str] = None) -> None:
         self._rid = rid
         self._name = name
+        self._title = title
         self._description = description
         self._created_by = created_by
         self._created_at = created_at
@@ -14694,6 +14704,10 @@ class module_ModuleMetadata(ConjureBeanType):
         """
         return self._name
 
+    @builtins.property
+    def title(self) -> str:
+        return self._title
+
     @builtins.property
     def description(self) -> str:
         return self._description
@@ -15867,23 +15881,21 @@ class module_UpdateModuleRequest(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'name': ConjureFieldDefinition('name', str),
+            'title': ConjureFieldDefinition('title', str),
             'description': ConjureFieldDefinition('description', str),
             'definition': ConjureFieldDefinition('definition', module_ModuleVersionDefinition)
         }
 
-    __slots__: List[str] = ['_name', '_description', '_definition']
+    __slots__: List[str] = ['_title', '_description', '_definition']
 
-    def __init__(self, definition: "module_ModuleVersionDefinition", description: str, name: str) -> None:
-        self._name = name
+    def __init__(self, definition: "module_ModuleVersionDefinition", description: str, title: str) -> None:
+        self._title = title
         self._description = description
         self._definition = definition
 
     @builtins.property
-    def name(self) -> str:
-        """The name of the module. This should be unique to the module in the current workspace.
-        """
-        return self._name
+    def title(self) -> str:
+        return self._title
 
     @builtins.property
     def description(self) -> str:
@@ -15929,6 +15941,148 @@ module_ValueType.__qualname__ = "ValueType"
 module_ValueType.__module__ = "nominal_api.module"
 
 
+class module_internal_BatchGetResolvedModuleDefinitionsRequest(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'requests': ConjureFieldDefinition('requests', List[module_internal_ModuleApplicationReference])
+        }
+
+    __slots__: List[str] = ['_requests']
+
+    def __init__(self, requests: List["module_internal_ModuleApplicationReference"]) -> None:
+        self._requests = requests
+
+    @builtins.property
+    def requests(self) -> List["module_internal_ModuleApplicationReference"]:
+        return self._requests
+
+
+module_internal_BatchGetResolvedModuleDefinitionsRequest.__name__ = "BatchGetResolvedModuleDefinitionsRequest"
+module_internal_BatchGetResolvedModuleDefinitionsRequest.__qualname__ = "BatchGetResolvedModuleDefinitionsRequest"
+module_internal_BatchGetResolvedModuleDefinitionsRequest.__module__ = "nominal_api.module_internal"
+
+
+class module_internal_InternalModuleService(Service):
+    """This service provides internal APIs related to modules.
+    """
+
+    def batch_get_resolved_module_definitions(self, auth_header: str, request: "module_internal_BatchGetResolvedModuleDefinitionsRequest") -> List["module_internal_ResolvedModuleVersionDefinition"]:
+        """Returns the resolved module definitions for the given module-asset pairs. If any of modules have not been
+applied to their corresponding asset, this will throw.
+        """
+        _conjure_encoder = ConjureEncoder()
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Content-Type': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, str] = {
+        }
+
+        _json: Any = _conjure_encoder.default(request)
+
+        _path = '/internal/scout/v2/module/resolved-module/batch-get'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'POST',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        _decoder = ConjureDecoder()
+        return _decoder.decode(_response.json(), List[module_internal_ResolvedModuleVersionDefinition], self._return_none_for_unknown_union_types)
+
+
+module_internal_InternalModuleService.__name__ = "InternalModuleService"
+module_internal_InternalModuleService.__qualname__ = "InternalModuleService"
+module_internal_InternalModuleService.__module__ = "nominal_api.module_internal"
+
+
+class module_internal_ModuleApplicationReference(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'module_name': ConjureFieldDefinition('moduleName', str),
+            'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid)
+        }
+
+    __slots__: List[str] = ['_module_name', '_asset_rid']
+
+    def __init__(self, asset_rid: str, module_name: str) -> None:
+        self._module_name = module_name
+        self._asset_rid = asset_rid
+
+    @builtins.property
+    def module_name(self) -> str:
+        return self._module_name
+
+    @builtins.property
+    def asset_rid(self) -> str:
+        return self._asset_rid
+
+
+module_internal_ModuleApplicationReference.__name__ = "ModuleApplicationReference"
+module_internal_ModuleApplicationReference.__qualname__ = "ModuleApplicationReference"
+module_internal_ModuleApplicationReference.__module__ = "nominal_api.module_internal"
+
+
+class module_internal_ResolvedModuleVersionDefinition(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'module_name': ConjureFieldDefinition('moduleName', str),
+            'asset_rid': ConjureFieldDefinition('assetRid', scout_rids_api_AssetRid),
+            'resolved_parameters': ConjureFieldDefinition('resolvedParameters', List[module_ModuleVariable]),
+            'default_variables': ConjureFieldDefinition('defaultVariables', List[module_ModuleVariable]),
+            'functions': ConjureFieldDefinition('functions', List[module_Function])
+        }
+
+    __slots__: List[str] = ['_module_name', '_asset_rid', '_resolved_parameters', '_default_variables', '_functions']
+
+    def __init__(self, asset_rid: str, default_variables: List["module_ModuleVariable"], functions: List["module_Function"], module_name: str, resolved_parameters: List["module_ModuleVariable"]) -> None:
+        self._module_name = module_name
+        self._asset_rid = asset_rid
+        self._resolved_parameters = resolved_parameters
+        self._default_variables = default_variables
+        self._functions = functions
+
+    @builtins.property
+    def module_name(self) -> str:
+        return self._module_name
+
+    @builtins.property
+    def asset_rid(self) -> str:
+        return self._asset_rid
+
+    @builtins.property
+    def resolved_parameters(self) -> List["module_ModuleVariable"]:
+        return self._resolved_parameters
+
+    @builtins.property
+    def default_variables(self) -> List["module_ModuleVariable"]:
+        return self._default_variables
+
+    @builtins.property
+    def functions(self) -> List["module_Function"]:
+        return self._functions
+
+
+module_internal_ResolvedModuleVersionDefinition.__name__ = "ResolvedModuleVersionDefinition"
+module_internal_ResolvedModuleVersionDefinition.__qualname__ = "ResolvedModuleVersionDefinition"
+module_internal_ResolvedModuleVersionDefinition.__module__ = "nominal_api.module_internal"
+
+
 class persistent_compute_api_AppendResult(ConjureBeanType):
     """An append result won't cover the full `StreamingComputeNodeRequest#windowWidth` but rather just a smaller 
 window. The end of the window that the append covers is guaranteed to be later than previously sent results.
@@ -48920,7 +49074,7 @@ class scout_compute_api_StabilityDetectionRanges(ConjureBeanType):
 the specified lookback window, including the current point. A point is considered stable if its value does 
 not deviate from the calculated min and the max by more than the threshold and the total number of points
 within the window is at least the specified amount. The threshold can be either fixed values or percentages 
-of the value. The minimum points threshold defaults to 2.
+of the value. The lookback window must be strictly positive. The minimum points threshold defaults to 2.
     """
 
     @builtins.classmethod
@@ -69926,6 +70080,8 @@ class scout_metadata_ResourceType(ConjureEnumType):
     '''EVENT'''
     DATASET = 'DATASET'
     '''DATASET'''
+    MODULE = 'MODULE'
+    '''MODULE'''
     UNKNOWN = 'UNKNOWN'
     '''UNKNOWN'''
 
@@ -86484,6 +86640,8 @@ api_ErrorType = str
 
 scout_compute_api_ComputeWithUnitsRequest = scout_compute_api_ComputeNodeRequest
 
+scout_rids_api_GroupRid = str
+
 scout_rids_api_Version = int
 
 scout_versioning_api_BranchName = str

nominal_api/module_internal/__init__.py

@@ -0,0 +1,15 @@
+# coding=utf-8
+from .._impl import (
+    module_internal_BatchGetResolvedModuleDefinitionsRequest as BatchGetResolvedModuleDefinitionsRequest,
+    module_internal_InternalModuleService as InternalModuleService,
+    module_internal_ModuleApplicationReference as ModuleApplicationReference,
+    module_internal_ResolvedModuleVersionDefinition as ResolvedModuleVersionDefinition,
+)
+
+__all__ = [
+    'BatchGetResolvedModuleDefinitionsRequest',
+    'ModuleApplicationReference',
+    'ResolvedModuleVersionDefinition',
+    'InternalModuleService',
+]
+

nominal_api/scout_rids_api/__init__.py

@@ -14,6 +14,7 @@ from .._impl import (
     scout_rids_api_DataReviewRid as DataReviewRid,
     scout_rids_api_FunctionLineageRid as FunctionLineageRid,
     scout_rids_api_FunctionRid as FunctionRid,
+    scout_rids_api_GroupRid as GroupRid,
     scout_rids_api_NotebookRid as NotebookRid,
     scout_rids_api_PendingReviewAlertState as PendingReviewAlertState,
     scout_rids_api_SnapshotRid as SnapshotRid,
@@ -40,6 +41,7 @@ __all__ = [
     'DataReviewRid',
     'FunctionLineageRid',
     'FunctionRid',
+    'GroupRid',
     'NotebookRid',
     'PendingReviewAlertState',
     'SnapshotRid',

{nominal_api-0.759.0.dist-info → nominal_api-0.761.0.dist-info}/METADATA

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

{nominal_api-0.759.0.dist-info → nominal_api-0.761.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=cMiHHbUR3HQJAgBRBEmQ1C3V7eqzDuRI87N4wPPMhFw,1989
-nominal_api/_impl.py,sha256=JRTNTYF_IyzRp9XjvxjiOdICaiZL0Z8EaL389jQGIW0,3400468
+nominal_api/__init__.py,sha256=r7z12m-sU3DZHZawsy_8EAD0FSAENC-lvArmtm-9fwY,2012
+nominal_api/_impl.py,sha256=_TthWus8cZIxRUPCd6KZUojdDjkr_tiLwUGCmd_BlIc,3406429
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=PMREKP7UhxJ1_gHkrlJET46qlDHksKMm6-woR1p6WnU,1970
 nominal_api/api_ids/__init__.py,sha256=sxqN5dMk6bOx0SKOd0ANG3_kmx1VtdSVotzEGn_q6sE,114
@@ -18,6 +18,7 @@ nominal_api/event/__init__.py,sha256=t5q8N5ozj3tHwRVhwtL6kwu-1-FMIoTGJT1RX75pwZM
 nominal_api/ingest_api/__init__.py,sha256=vkOFk6X2S4jpv0FBwsT9JpaK7Hb7lk9nkMNwcTi4zTw,11266
 nominal_api/ingest_workflow_api/__init__.py,sha256=lTCb7s4VCrpur0TDpTy_EDvUdHJ4UKqcTv8MYiEeeko,2954
 nominal_api/module/__init__.py,sha256=lM3ETKLddEed2ZeQgjz1eb0C_AEU0qnGX_sceK05sc0,3650
+nominal_api/module_internal/__init__.py,sha256=qEQ3cxDc78ImuKO1Fr59cnMZvAvidMgjatZAJMsyUKc,545
 nominal_api/modules_api/__init__.py,sha256=V8ccEclLTh6CbzZvpRhcncPFqFBU-sSUSkfr4KzXL6w,112
 nominal_api/persistent_compute_api/__init__.py,sha256=bOWBiRLJbl3winMP9EowCUpPpRIUYyejua3059wJWQk,3314
 nominal_api/scout/__init__.py,sha256=dZzrrqBeio2l0txhlNoHSfv6QsA9a3EVDp0_XpubUGk,481
@@ -50,7 +51,7 @@ nominal_api/scout_layout_api/__init__.py,sha256=sUWO0V8Y0I0pa-nmKAjkeoIgTpP9tSG1
 nominal_api/scout_metadata/__init__.py,sha256=m8UNk53xgDtiZCLU2ZyfDxwwFC6_XztE9INJM2R1ApA,475
 nominal_api/scout_notebook_api/__init__.py,sha256=b-4ONsrgT2NziNHq8em09YxbZcQcKLWmPYkpxBFHPFA,1820
 nominal_api/scout_plotting/__init__.py,sha256=RJK9HlPmNW_dxSz7CprwjfNKke86x11rQ7BF5pwrBv4,127
-nominal_api/scout_rids_api/__init__.py,sha256=inHWSfRXEH29EMMmNW7uWGAd7WGTYoeNs-oD35UA8IE,1747
+nominal_api/scout_rids_api/__init__.py,sha256=g0Ki940X9P5GEU6e68mfLTBhbxb7WpRSi8GALDQ7nXg,1804
 nominal_api/scout_run_api/__init__.py,sha256=DOerd1dppDM4RLDgPrjh-3i-VAaXtp6XPEqkET0N5W0,4051
 nominal_api/scout_template_api/__init__.py,sha256=Yu7FHTypJv09dBKqnWS_dDeXdwI1hgGGZNDbMOHZKr8,1550
 nominal_api/scout_units_api/__init__.py,sha256=gf47pW6JIcP3FgL1UuHwkibj266FCRszL9q6PGx0-Rg,512
@@ -74,7 +75,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.759.0.dist-info/METADATA,sha256=zjr5tpByzXGzbVYZEAYlXz2CRcC77-UNGejtsXmodMo,199
-nominal_api-0.759.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.759.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.759.0.dist-info/RECORD,,
+nominal_api-0.761.0.dist-info/METADATA,sha256=TCnQzB5W1LvlwZcQzmAcK1zIKvXppSeGux-M2IOvgjo,199
+nominal_api-0.761.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.761.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.761.0.dist-info/RECORD,,