nominal-api 0.654.0__tar.gz → 0.655.0__tar.gz

{nominal_api-0.654.0 → nominal_api-0.655.0}/PKG-INFO

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

{nominal_api-0.654.0 → nominal_api-0.655.0}/nominal_api/__init__.py

@@ -75,5 +75,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.654.0"
+__version__ = "0.655.0"
 

{nominal_api-0.654.0 → nominal_api-0.655.0}/nominal_api/_impl.py

@@ -7621,16 +7621,16 @@ class ingest_api_ContainerizedOpts(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'sources': ConjureFieldDefinition('sources', Dict[ingest_api_EnvironmentVariable, ingest_api_IngestSource]),
-            'extractor': ConjureFieldDefinition('extractor', ingest_api_ContainerizedExtractorRid),
+            'extractor_rid': ConjureFieldDefinition('extractorRid', ingest_api_ContainerizedExtractorRid),
             'tag': ConjureFieldDefinition('tag', OptionalTypeWrapper[str]),
             'target': ConjureFieldDefinition('target', ingest_api_DatasetIngestTarget)
         }
 
-    __slots__: List[str] = ['_sources', '_extractor', '_tag', '_target']
+    __slots__: List[str] = ['_sources', '_extractor_rid', '_tag', '_target']
 
-    def __init__(self, extractor: str, sources: Dict[str, "ingest_api_IngestSource"], target: "ingest_api_DatasetIngestTarget", tag: Optional[str] = None) -> None:
+    def __init__(self, extractor_rid: str, sources: Dict[str, "ingest_api_IngestSource"], target: "ingest_api_DatasetIngestTarget", tag: Optional[str] = None) -> None:
         self._sources = sources
-        self._extractor = extractor
+        self._extractor_rid = extractor_rid
         self._tag = tag
         self._target = target
 
@@ -7639,8 +7639,8 @@ class ingest_api_ContainerizedOpts(ConjureBeanType):
         return self._sources
 
     @builtins.property
-    def extractor(self) -> str:
-        return self._extractor
+    def extractor_rid(self) -> str:
+        return self._extractor_rid
 
     @builtins.property
     def tag(self) -> Optional[str]:
@@ -8228,16 +8228,18 @@ class ingest_api_FileExtractionInput(ConjureBeanType):
             'environment_variable': ConjureFieldDefinition('environmentVariable', ingest_api_EnvironmentVariable),
             'name': ConjureFieldDefinition('name', str),
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
-            'regex': ConjureFieldDefinition('regex', OptionalTypeWrapper[str])
+            'file_filters': ConjureFieldDefinition('fileFilters', List[ingest_api_FileFilter]),
+            'required': ConjureFieldDefinition('required', OptionalTypeWrapper[bool])
         }
 
-    __slots__: List[str] = ['_environment_variable', '_name', '_description', '_regex']
+    __slots__: List[str] = ['_environment_variable', '_name', '_description', '_file_filters', '_required']
 
-    def __init__(self, environment_variable: str, name: str, description: Optional[str] = None, regex: Optional[str] = None) -> None:
+    def __init__(self, environment_variable: str, file_filters: List["ingest_api_FileFilter"], name: str, description: Optional[str] = None, required: Optional[bool] = None) -> None:
         self._environment_variable = environment_variable
         self._name = name
         self._description = description
-        self._regex = regex
+        self._file_filters = file_filters
+        self._required = required
 
     @builtins.property
     def environment_variable(self) -> str:
@@ -8261,11 +8263,18 @@ class ingest_api_FileExtractionInput(ConjureBeanType):
         return self._description
 
     @builtins.property
-    def regex(self) -> Optional[str]:
+    def file_filters(self) -> List["ingest_api_FileFilter"]:
         """
-        Optionally filter files by regex for file selection. Will not be enforced at runtime, so containers need to handle their own validation.
+        Optionally filter files for file selection
         """
-        return self._regex
+        return self._file_filters
+
+    @builtins.property
+    def required(self) -> Optional[bool]:
+        """
+        Whether the input file is required for the extractor to run.
+        """
+        return self._required
 
 
 ingest_api_FileExtractionInput.__name__ = "FileExtractionInput"
@@ -8273,6 +8282,62 @@ ingest_api_FileExtractionInput.__qualname__ = "FileExtractionInput"
 ingest_api_FileExtractionInput.__module__ = "nominal_api.ingest_api"
 
 
+class ingest_api_FileFilter(ConjureUnionType):
+    _suffix: Optional[str] = None
+
+    @builtins.classmethod
+    def _options(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'suffix': ConjureFieldDefinition('suffix', ingest_api_FileSuffix)
+        }
+
+    def __init__(
+            self,
+            suffix: Optional[str] = None,
+            type_of_union: Optional[str] = None
+            ) -> None:
+        if type_of_union is None:
+            if (suffix is not None) != 1:
+                raise ValueError('a union must contain a single member')
+
+            if suffix is not None:
+                self._suffix = suffix
+                self._type = 'suffix'
+
+        elif type_of_union == 'suffix':
+            if suffix is None:
+                raise ValueError('a union value must not be None')
+            self._suffix = suffix
+            self._type = 'suffix'
+
+    @builtins.property
+    def suffix(self) -> Optional[str]:
+        return self._suffix
+
+    def accept(self, visitor) -> Any:
+        if not isinstance(visitor, ingest_api_FileFilterVisitor):
+            raise ValueError('{} is not an instance of ingest_api_FileFilterVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'suffix' and self.suffix is not None:
+            return visitor._suffix(self.suffix)
+
+
+ingest_api_FileFilter.__name__ = "FileFilter"
+ingest_api_FileFilter.__qualname__ = "FileFilter"
+ingest_api_FileFilter.__module__ = "nominal_api.ingest_api"
+
+
+class ingest_api_FileFilterVisitor:
+
+    @abstractmethod
+    def _suffix(self, suffix: str) -> Any:
+        pass
+
+
+ingest_api_FileFilterVisitor.__name__ = "FileFilterVisitor"
+ingest_api_FileFilterVisitor.__qualname__ = "FileFilterVisitor"
+ingest_api_FileFilterVisitor.__module__ = "nominal_api.ingest_api"
+
+
 class ingest_api_GcsIngestSource(ConjureBeanType):
 
     @builtins.classmethod
@@ -10885,6 +10950,7 @@ class ingest_api_ReingestDatasetsRequest(ConjureBeanType):
         """
         The datasets to reingest data from. Can only include tagless, non-streaming datasets (V1).
 The datasets must be of the same granularity and must only include CSV or Parquet files.
+Will attempt to reingest from datasets in list order.
         """
         return self._source_datasets
 
@@ -12125,20 +12191,20 @@ class ingest_workflow_api_EnsureExtractorJobCreatedRequest(ConjureBeanType):
             'ingest_job_uuid': ConjureFieldDefinition('ingestJobUuid', str),
             'containerized_extractor': ConjureFieldDefinition('containerizedExtractor', ingest_api_ContainerizedExtractor),
             'tag': ConjureFieldDefinition('tag', str),
-            'source_handles': ConjureFieldDefinition('sourceHandles', Dict[str, scout_catalog_S3Handle]),
+            'validated_file_inputs': ConjureFieldDefinition('validatedFileInputs', List[ingest_workflow_api_ValidatedFileInput]),
             'multipart_upload_details': ConjureFieldDefinition('multipartUploadDetails', ingest_workflow_api_MultipartUploadDetails),
             'image_pull_secret_name': ConjureFieldDefinition('imagePullSecretName', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_bearer_token', '_workspace_rid', '_ingest_job_uuid', '_containerized_extractor', '_tag', '_source_handles', '_multipart_upload_details', '_image_pull_secret_name']
+    __slots__: List[str] = ['_bearer_token', '_workspace_rid', '_ingest_job_uuid', '_containerized_extractor', '_tag', '_validated_file_inputs', '_multipart_upload_details', '_image_pull_secret_name']
 
-    def __init__(self, bearer_token: str, containerized_extractor: "ingest_api_ContainerizedExtractor", ingest_job_uuid: str, multipart_upload_details: "ingest_workflow_api_MultipartUploadDetails", source_handles: Dict[str, "scout_catalog_S3Handle"], tag: str, workspace_rid: str, image_pull_secret_name: Optional[str] = None) -> None:
+    def __init__(self, bearer_token: str, containerized_extractor: "ingest_api_ContainerizedExtractor", ingest_job_uuid: str, multipart_upload_details: "ingest_workflow_api_MultipartUploadDetails", tag: str, validated_file_inputs: List["ingest_workflow_api_ValidatedFileInput"], workspace_rid: str, image_pull_secret_name: Optional[str] = None) -> None:
         self._bearer_token = bearer_token
         self._workspace_rid = workspace_rid
         self._ingest_job_uuid = ingest_job_uuid
         self._containerized_extractor = containerized_extractor
         self._tag = tag
-        self._source_handles = source_handles
+        self._validated_file_inputs = validated_file_inputs
         self._multipart_upload_details = multipart_upload_details
         self._image_pull_secret_name = image_pull_secret_name
 
@@ -12163,8 +12229,8 @@ class ingest_workflow_api_EnsureExtractorJobCreatedRequest(ConjureBeanType):
         return self._tag
 
     @builtins.property
-    def source_handles(self) -> Dict[str, "scout_catalog_S3Handle"]:
-        return self._source_handles
+    def validated_file_inputs(self) -> List["ingest_workflow_api_ValidatedFileInput"]:
+        return self._validated_file_inputs
 
     @builtins.property
     def multipart_upload_details(self) -> "ingest_workflow_api_MultipartUploadDetails":
@@ -12721,6 +12787,35 @@ ingest_workflow_api_ObjectLocator.__qualname__ = "ObjectLocator"
 ingest_workflow_api_ObjectLocator.__module__ = "nominal_api.ingest_workflow_api"
 
 
+class ingest_workflow_api_PresignedFileInput(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'url': ConjureFieldDefinition('url', ingest_workflow_api_PresignedUrl),
+            'input': ConjureFieldDefinition('input', ingest_workflow_api_ValidatedFileInput)
+        }
+
+    __slots__: List[str] = ['_url', '_input']
+
+    def __init__(self, input: "ingest_workflow_api_ValidatedFileInput", url: str) -> None:
+        self._url = url
+        self._input = input
+
+    @builtins.property
+    def url(self) -> str:
+        return self._url
+
+    @builtins.property
+    def input(self) -> "ingest_workflow_api_ValidatedFileInput":
+        return self._input
+
+
+ingest_workflow_api_PresignedFileInput.__name__ = "PresignedFileInput"
+ingest_workflow_api_PresignedFileInput.__qualname__ = "PresignedFileInput"
+ingest_workflow_api_PresignedFileInput.__module__ = "nominal_api.ingest_workflow_api"
+
+
 class ingest_workflow_api_TimeUnitSeconds(ConjureEnumType):
 
     SECONDS = 'SECONDS'
@@ -12737,6 +12832,50 @@ ingest_workflow_api_TimeUnitSeconds.__qualname__ = "TimeUnitSeconds"
 ingest_workflow_api_TimeUnitSeconds.__module__ = "nominal_api.ingest_workflow_api"
 
 
+class ingest_workflow_api_ValidatedFileInput(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'handle': ConjureFieldDefinition('handle', scout_catalog_S3Handle),
+            'file_name': ConjureFieldDefinition('fileName', str),
+            'env_var': ConjureFieldDefinition('envVar', str)
+        }
+
+    __slots__: List[str] = ['_handle', '_file_name', '_env_var']
+
+    def __init__(self, env_var: str, file_name: str, handle: "scout_catalog_S3Handle") -> None:
+        self._handle = handle
+        self._file_name = file_name
+        self._env_var = env_var
+
+    @builtins.property
+    def handle(self) -> "scout_catalog_S3Handle":
+        """
+        Path to the input file in S3.
+        """
+        return self._handle
+
+    @builtins.property
+    def file_name(self) -> str:
+        """
+        Name of the file that will be placed on disk.
+        """
+        return self._file_name
+
+    @builtins.property
+    def env_var(self) -> str:
+        """
+        Environment variable that will store the path to the file.
+        """
+        return self._env_var
+
+
+ingest_workflow_api_ValidatedFileInput.__name__ = "ValidatedFileInput"
+ingest_workflow_api_ValidatedFileInput.__qualname__ = "ValidatedFileInput"
+ingest_workflow_api_ValidatedFileInput.__module__ = "nominal_api.ingest_workflow_api"
+
+
 class persistent_compute_api_AppendResult(ConjureBeanType):
     """
     An append result won't cover the full `StreamingComputeNodeRequest#windowWidth` but rather just a smaller 
@@ -79791,6 +79930,8 @@ scout_rids_api_SnapshotRid = str
 
 scout_units_api_UnitName = str
 
+ingest_api_FileSuffix = str
+
 scout_datasource_connection_api_TableName = str
 
 timeseries_seriescache_api_Resolution = int
@@ -79937,6 +80078,8 @@ scout_video_api_ErrorType = str
 
 scout_comparisonnotebook_api_ComparisonChannelVariableMap = Dict[scout_comparisonnotebook_api_VariableName, scout_comparisonnotebook_api_ChannelVariable]
 
+ingest_workflow_api_PresignedUrl = str
+
 timeseries_logicalseries_api_FieldName = str
 
 scout_channelvariables_api_WorkbookChannelVariableMap = Dict[scout_channelvariables_api_ChannelVariableName, scout_channelvariables_api_ChannelVariable]

{nominal_api-0.654.0 → nominal_api-0.655.0}/nominal_api/ingest_api/__init__.py

@@ -30,6 +30,9 @@ from .._impl import (
     ingest_api_ExistingDatasetIngestDestination as ExistingDatasetIngestDestination,
     ingest_api_ExistingVideoIngestDestination as ExistingVideoIngestDestination,
     ingest_api_FileExtractionInput as FileExtractionInput,
+    ingest_api_FileFilter as FileFilter,
+    ingest_api_FileFilterVisitor as FileFilterVisitor,
+    ingest_api_FileSuffix as FileSuffix,
     ingest_api_GcsIngestSource as GcsIngestSource,
     ingest_api_GetContainerizedExtractorsRequest as GetContainerizedExtractorsRequest,
     ingest_api_GetContainerizedExtractorsResponse as GetContainerizedExtractorsResponse,

{nominal_api-0.654.0 → nominal_api-0.655.0}/nominal_api/ingest_workflow_api/__init__.py

@@ -20,6 +20,9 @@ from .._impl import (
     ingest_workflow_api_McapTopicName as McapTopicName,
     ingest_workflow_api_MultipartUploadDetails as MultipartUploadDetails,
     ingest_workflow_api_ObjectLocator as ObjectLocator,
+    ingest_workflow_api_PresignedFileInput as PresignedFileInput,
+    ingest_workflow_api_PresignedUrl as PresignedUrl,
     ingest_workflow_api_TimeUnitSeconds as TimeUnitSeconds,
+    ingest_workflow_api_ValidatedFileInput as ValidatedFileInput,
 )
 

{nominal_api-0.654.0 → nominal_api-0.655.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.654.0 → nominal_api-0.655.0}/setup.py

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