nominal-api 0.725.0__py3-none-any.whl → 0.726.0__py3-none-any.whl

nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.725.0"
+__version__ = "0.726.0"
 

nominal_api/_impl.py

@@ -10414,6 +10414,43 @@ Will only reingest dataset files and will drop streaming data from datasets.
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), ingest_api_ReingestDatasetsResponse, self._return_none_for_unknown_union_types)
 
+    def delete_file(self, auth_header: str, dataset_rid: str, file_id: str) -> None:
+        """This is a best effort deletion of the file's data based on the ingestedAt timestamp. This is an unreversible
+action. Only v2 dataset file deletion is supported.
+!!!WARNING!!!
+It's possible that the file has overwritten points, in which case, those older points will not be recovered.
+Only use this endpoint if this is acceptable, the data across files are disjoint, or you're willing to
+re-ingest files to manually recover older points.
+        """
+        _conjure_encoder = ConjureEncoder()
+
+        _headers: Dict[str, Any] = {
+            'Accept': 'application/json',
+            'Authorization': auth_header,
+        }
+
+        _params: Dict[str, Any] = {
+        }
+
+        _path_params: Dict[str, str] = {
+            'datasetRid': quote(str(_conjure_encoder.default(dataset_rid)), safe=''),
+            'fileId': quote(str(_conjure_encoder.default(file_id)), safe=''),
+        }
+
+        _json: Any = None
+
+        _path = '/ingest/v1/delete-file/{datasetRid}/file/{fileId}'
+        _path = _path.format(**_path_params)
+
+        _response: Response = self._request(
+            'DELETE',
+            self._uri + _path,
+            params=_params,
+            headers=_headers,
+            json=_json)
+
+        return
+
 
 ingest_api_IngestService.__name__ = "IngestService"
 ingest_api_IngestService.__qualname__ = "IngestService"
@@ -21251,12 +21288,13 @@ class scout_catalog_DatasetFile(ConjureBeanType):
             'ingest_status': ConjureFieldDefinition('ingestStatus', api_IngestStatusV2),
             'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[scout_catalog_TimestampMetadata]),
             'origin_file_paths': ConjureFieldDefinition('originFilePaths', OptionalTypeWrapper[List[str]]),
-            'ingest_job_rid': ConjureFieldDefinition('ingestJobRid', OptionalTypeWrapper[ingest_api_IngestJobRid])
+            'ingest_job_rid': ConjureFieldDefinition('ingestJobRid', OptionalTypeWrapper[ingest_api_IngestJobRid]),
+            'deleted_at': ConjureFieldDefinition('deletedAt', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_id', '_dataset_rid', '_name', '_handle', '_bounds', '_uploaded_at', '_ingested_at', '_ingest_status', '_timestamp_metadata', '_origin_file_paths', '_ingest_job_rid']
+    __slots__: List[str] = ['_id', '_dataset_rid', '_name', '_handle', '_bounds', '_uploaded_at', '_ingested_at', '_ingest_status', '_timestamp_metadata', '_origin_file_paths', '_ingest_job_rid', '_deleted_at']
 
-    def __init__(self, dataset_rid: str, handle: "scout_catalog_Handle", id: str, ingest_status: "api_IngestStatusV2", name: str, uploaded_at: str, bounds: Optional["scout_catalog_Bounds"] = None, ingest_job_rid: Optional[str] = None, ingested_at: Optional[str] = None, origin_file_paths: Optional[List[str]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
+    def __init__(self, dataset_rid: str, handle: "scout_catalog_Handle", id: str, ingest_status: "api_IngestStatusV2", name: str, uploaded_at: str, bounds: Optional["scout_catalog_Bounds"] = None, deleted_at: Optional[str] = None, ingest_job_rid: Optional[str] = None, ingested_at: Optional[str] = None, origin_file_paths: Optional[List[str]] = None, timestamp_metadata: Optional["scout_catalog_TimestampMetadata"] = None) -> None:
         self._id = id
         self._dataset_rid = dataset_rid
         self._name = name
@@ -21268,6 +21306,7 @@ class scout_catalog_DatasetFile(ConjureBeanType):
         self._timestamp_metadata = timestamp_metadata
         self._origin_file_paths = origin_file_paths
         self._ingest_job_rid = ingest_job_rid
+        self._deleted_at = deleted_at
 
     @builtins.property
     def id(self) -> str:
@@ -21318,6 +21357,12 @@ ingested for any reason or is still being processed, then this value will be emp
     def ingest_job_rid(self) -> Optional[str]:
         return self._ingest_job_rid
 
+    @builtins.property
+    def deleted_at(self) -> Optional[str]:
+        """Timestamp that the file is deleted at, only present if the file has been deleted.
+        """
+        return self._deleted_at
+
 
 scout_catalog_DatasetFile.__name__ = "DatasetFile"
 scout_catalog_DatasetFile.__qualname__ = "DatasetFile"
@@ -29637,13 +29682,14 @@ class scout_checks_api_Check(ConjureBeanType):
             'auto_generated_title': ConjureFieldDefinition('autoGeneratedTitle', OptionalTypeWrapper[str]),
             'auto_generated_description': ConjureFieldDefinition('autoGeneratedDescription', OptionalTypeWrapper[str]),
             'priority': ConjureFieldDefinition('priority', scout_api_Priority),
+            'generated_event_type': ConjureFieldDefinition('generatedEventType', event_EventType),
             'chart': ConjureFieldDefinition('chart', OptionalTypeWrapper[scout_rids_api_VersionedVizId]),
             'condition': ConjureFieldDefinition('condition', OptionalTypeWrapper[scout_checks_api_CheckCondition])
         }
 
-    __slots__: List[str] = ['_rid', '_check_lineage_rid', '_title', '_description', '_auto_generated_title', '_auto_generated_description', '_priority', '_chart', '_condition']
+    __slots__: List[str] = ['_rid', '_check_lineage_rid', '_title', '_description', '_auto_generated_title', '_auto_generated_description', '_priority', '_generated_event_type', '_chart', '_condition']
 
-    def __init__(self, check_lineage_rid: str, description: str, priority: "scout_api_Priority", rid: str, title: str, auto_generated_description: Optional[str] = None, auto_generated_title: Optional[str] = None, chart: Optional["scout_rids_api_VersionedVizId"] = None, condition: Optional["scout_checks_api_CheckCondition"] = None) -> None:
+    def __init__(self, check_lineage_rid: str, description: str, generated_event_type: "event_EventType", priority: "scout_api_Priority", rid: str, title: str, auto_generated_description: Optional[str] = None, auto_generated_title: Optional[str] = None, chart: Optional["scout_rids_api_VersionedVizId"] = None, condition: Optional["scout_checks_api_CheckCondition"] = None) -> None:
         self._rid = rid
         self._check_lineage_rid = check_lineage_rid
         self._title = title
@@ -29651,6 +29697,7 @@ class scout_checks_api_Check(ConjureBeanType):
         self._auto_generated_title = auto_generated_title
         self._auto_generated_description = auto_generated_description
         self._priority = priority
+        self._generated_event_type = generated_event_type
         self._chart = chart
         self._condition = condition
 
@@ -29682,6 +29729,10 @@ class scout_checks_api_Check(ConjureBeanType):
     def priority(self) -> "scout_api_Priority":
         return self._priority
 
+    @builtins.property
+    def generated_event_type(self) -> "event_EventType":
+        return self._generated_event_type
+
     @builtins.property
     def chart(self) -> Optional["scout_rids_api_VersionedVizId"]:
         return self._chart
@@ -31043,19 +31094,21 @@ class scout_checks_api_CreateCheckRequest(ConjureBeanType):
             'auto_generated_title': ConjureFieldDefinition('autoGeneratedTitle', OptionalTypeWrapper[str]),
             'auto_generated_description': ConjureFieldDefinition('autoGeneratedDescription', OptionalTypeWrapper[str]),
             'priority': ConjureFieldDefinition('priority', scout_api_Priority),
+            'generated_event_type': ConjureFieldDefinition('generatedEventType', OptionalTypeWrapper[event_EventType]),
             'chart': ConjureFieldDefinition('chart', OptionalTypeWrapper[scout_rids_api_VersionedVizId]),
             'condition': ConjureFieldDefinition('condition', OptionalTypeWrapper[scout_checks_api_UnresolvedCheckCondition])
         }
 
-    __slots__: List[str] = ['_check_lineage_rid', '_title', '_description', '_auto_generated_title', '_auto_generated_description', '_priority', '_chart', '_condition']
+    __slots__: List[str] = ['_check_lineage_rid', '_title', '_description', '_auto_generated_title', '_auto_generated_description', '_priority', '_generated_event_type', '_chart', '_condition']
 
-    def __init__(self, description: str, priority: "scout_api_Priority", title: str, auto_generated_description: Optional[str] = None, auto_generated_title: Optional[str] = None, chart: Optional["scout_rids_api_VersionedVizId"] = None, check_lineage_rid: Optional[str] = None, condition: Optional["scout_checks_api_UnresolvedCheckCondition"] = None) -> None:
+    def __init__(self, description: str, priority: "scout_api_Priority", title: str, auto_generated_description: Optional[str] = None, auto_generated_title: Optional[str] = None, chart: Optional["scout_rids_api_VersionedVizId"] = None, check_lineage_rid: Optional[str] = None, condition: Optional["scout_checks_api_UnresolvedCheckCondition"] = None, generated_event_type: Optional["event_EventType"] = None) -> None:
         self._check_lineage_rid = check_lineage_rid
         self._title = title
         self._description = description
         self._auto_generated_title = auto_generated_title
         self._auto_generated_description = auto_generated_description
         self._priority = priority
+        self._generated_event_type = generated_event_type
         self._chart = chart
         self._condition = condition
 
@@ -31086,6 +31139,10 @@ This is named checkLineageRid for historical reasons but is actually a UUID.
     def priority(self) -> "scout_api_Priority":
         return self._priority
 
+    @builtins.property
+    def generated_event_type(self) -> Optional["event_EventType"]:
+        return self._generated_event_type
+
     @builtins.property
     def chart(self) -> Optional["scout_rids_api_VersionedVizId"]:
         return self._chart

{nominal_api-0.725.0.dist-info → nominal_api-0.726.0.dist-info}/METADATA

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

{nominal_api-0.725.0.dist-info → nominal_api-0.726.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=KYYVoHMivR7E3-rJTYGwx_qN4xe4qo160FdWZDJTPCY,1956
-nominal_api/_impl.py,sha256=QapcPWTFgMMG7UNCqGSm1aDCaZu3RB5Karcxww7iLS0,3290854
+nominal_api/__init__.py,sha256=6PJh77T24dhZiTAM-w5xhWc84GIEfPyN_P7ISgdpnrQ,1956
+nominal_api/_impl.py,sha256=3jydt-Qo5a2BAnwYRWtZpTX2HDNfRbh0uoYlr5WBNf0,3293297
 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
@@ -72,7 +72,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.725.0.dist-info/METADATA,sha256=lvIVqq_3oM9BCAmC_YeNwt1d_kLzEXdgQxeJcbxRN4g,199
-nominal_api-0.725.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nominal_api-0.725.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.725.0.dist-info/RECORD,,
+nominal_api-0.726.0.dist-info/METADATA,sha256=5_Nk8XxVAP2HmQuiHqZKAtu4U9Yx7dUhrS8aJcZOBKc,199
+nominal_api-0.726.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nominal_api-0.726.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.726.0.dist-info/RECORD,,