nominal-api 0.938.0__tar.gz → 0.940.0__tar.gz

{nominal_api-0.938.0 → nominal_api-0.940.0}/PKG-INFO

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

{nominal_api-0.938.0 → nominal_api-0.940.0}/nominal_api/__init__.py

@@ -81,5 +81,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.17.0"
 
-__version__ = "0.938.0"
+__version__ = "0.940.0"
 

{nominal_api-0.938.0 → nominal_api-0.940.0}/nominal_api/_impl.py

@@ -8608,6 +8608,7 @@ class ingest_api_ContainerizedExtractor(ConjureBeanType):
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'image': ConjureFieldDefinition('image', ingest_api_DockerImageSource),
             'inputs': ConjureFieldDefinition('inputs', List[ingest_api_FileExtractionInput]),
+            'parameters': ConjureFieldDefinition('parameters', List[ingest_api_FileExtractionParameter]),
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'labels': ConjureFieldDefinition('labels', List[api_Label]),
             'created_at': ConjureFieldDefinition('createdAt', str),
@@ -8616,14 +8617,15 @@ class ingest_api_ContainerizedExtractor(ConjureBeanType):
             'output_file_format': ConjureFieldDefinition('outputFileFormat', ingest_api_FileOutputFormat)
         }
 
-    __slots__: List[str] = ['_rid', '_name', '_description', '_image', '_inputs', '_properties', '_labels', '_created_at', '_is_archived', '_timestamp_metadata', '_output_file_format']
+    __slots__: List[str] = ['_rid', '_name', '_description', '_image', '_inputs', '_parameters', '_properties', '_labels', '_created_at', '_is_archived', '_timestamp_metadata', '_output_file_format']
 
-    def __init__(self, created_at: str, image: "ingest_api_DockerImageSource", inputs: List["ingest_api_FileExtractionInput"], is_archived: bool, labels: List[str], name: str, output_file_format: "ingest_api_FileOutputFormat", properties: Dict[str, str], rid: str, timestamp_metadata: "ingest_api_TimestampMetadata", description: Optional[str] = None) -> None:
+    def __init__(self, created_at: str, image: "ingest_api_DockerImageSource", inputs: List["ingest_api_FileExtractionInput"], is_archived: bool, labels: List[str], name: str, output_file_format: "ingest_api_FileOutputFormat", parameters: List["ingest_api_FileExtractionParameter"], properties: Dict[str, str], rid: str, timestamp_metadata: "ingest_api_TimestampMetadata", description: Optional[str] = None) -> None:
         self._rid = rid
         self._name = name
         self._description = description
         self._image = image
         self._inputs = inputs
+        self._parameters = parameters
         self._properties = properties
         self._labels = labels
         self._created_at = created_at
@@ -8661,6 +8663,12 @@ class ingest_api_ContainerizedExtractor(ConjureBeanType):
         """
         return self._inputs
 
+    @builtins.property
+    def parameters(self) -> List["ingest_api_FileExtractionParameter"]:
+        """Describes the parameters of the extractor.
+        """
+        return self._parameters
+
     @builtins.property
     def properties(self) -> Dict[str, str]:
         """Additional properties associated with this extractor.
@@ -8910,15 +8918,17 @@ class ingest_api_ContainerizedOpts(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'sources': ConjureFieldDefinition('sources', Dict[ingest_api_EnvironmentVariable, ingest_api_IngestSource]),
+            'arguments': ConjureFieldDefinition('arguments', Dict[ingest_api_EnvironmentVariable, str]),
             'extractor_rid': ConjureFieldDefinition('extractorRid', ingest_api_ContainerizedExtractorRid),
             'tag': ConjureFieldDefinition('tag', OptionalTypeWrapper[str]),
             'target': ConjureFieldDefinition('target', ingest_api_DatasetIngestTarget)
         }
 
-    __slots__: List[str] = ['_sources', '_extractor_rid', '_tag', '_target']
+    __slots__: List[str] = ['_sources', '_arguments', '_extractor_rid', '_tag', '_target']
 
-    def __init__(self, extractor_rid: str, sources: Dict[str, "ingest_api_IngestSource"], target: "ingest_api_DatasetIngestTarget", tag: Optional[str] = None) -> None:
+    def __init__(self, arguments: Dict[str, str], extractor_rid: str, sources: Dict[str, "ingest_api_IngestSource"], target: "ingest_api_DatasetIngestTarget", tag: Optional[str] = None) -> None:
         self._sources = sources
+        self._arguments = arguments
         self._extractor_rid = extractor_rid
         self._tag = tag
         self._target = target
@@ -8927,6 +8937,10 @@ class ingest_api_ContainerizedOpts(ConjureBeanType):
     def sources(self) -> Dict[str, "ingest_api_IngestSource"]:
         return self._sources
 
+    @builtins.property
+    def arguments(self) -> Dict[str, str]:
+        return self._arguments
+
     @builtins.property
     def extractor_rid(self) -> str:
         return self._extractor_rid
@@ -9488,6 +9502,57 @@ ingest_api_FileExtractionInput.__qualname__ = "FileExtractionInput"
 ingest_api_FileExtractionInput.__module__ = "nominal_api.ingest_api"
 
 
+class ingest_api_FileExtractionParameter(ConjureBeanType):
+    """Defines an input parameter to be provided to the extractor.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'environment_variable': ConjureFieldDefinition('environmentVariable', ingest_api_EnvironmentVariable),
+            'name': ConjureFieldDefinition('name', str),
+            'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
+            'required': ConjureFieldDefinition('required', OptionalTypeWrapper[bool])
+        }
+
+    __slots__: List[str] = ['_environment_variable', '_name', '_description', '_required']
+
+    def __init__(self, environment_variable: str, name: str, description: Optional[str] = None, required: Optional[bool] = None) -> None:
+        self._environment_variable = environment_variable
+        self._name = name
+        self._description = description
+        self._required = required
+
+    @builtins.property
+    def environment_variable(self) -> str:
+        """The environment variable that stores the argument
+        """
+        return self._environment_variable
+
+    @builtins.property
+    def name(self) -> str:
+        """Name of the parameter which users will be prompted with
+        """
+        return self._name
+
+    @builtins.property
+    def description(self) -> Optional[str]:
+        """Description of the parameter which users will be prompted with
+        """
+        return self._description
+
+    @builtins.property
+    def required(self) -> Optional[bool]:
+        """Whether the parameter is required for the extractor to run.
+        """
+        return self._required
+
+
+ingest_api_FileExtractionParameter.__name__ = "FileExtractionParameter"
+ingest_api_FileExtractionParameter.__qualname__ = "FileExtractionParameter"
+ingest_api_FileExtractionParameter.__module__ = "nominal_api.ingest_api"
+
+
 class ingest_api_FileFilter(ConjureUnionType):
     _suffix: Optional[str] = None
 
@@ -12217,6 +12282,7 @@ class ingest_api_RegisterContainerizedExtractorRequest(ConjureBeanType):
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'image': ConjureFieldDefinition('image', ingest_api_DockerImageSource),
             'inputs': ConjureFieldDefinition('inputs', List[ingest_api_FileExtractionInput]),
+            'parameters': ConjureFieldDefinition('parameters', List[ingest_api_FileExtractionParameter]),
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'labels': ConjureFieldDefinition('labels', List[api_Label]),
             'workspace': ConjureFieldDefinition('workspace', api_rids_WorkspaceRid),
@@ -12224,13 +12290,14 @@ class ingest_api_RegisterContainerizedExtractorRequest(ConjureBeanType):
             'output_file_format': ConjureFieldDefinition('outputFileFormat', OptionalTypeWrapper[ingest_api_FileOutputFormat])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_image', '_inputs', '_properties', '_labels', '_workspace', '_timestamp_metadata', '_output_file_format']
+    __slots__: List[str] = ['_name', '_description', '_image', '_inputs', '_parameters', '_properties', '_labels', '_workspace', '_timestamp_metadata', '_output_file_format']
 
-    def __init__(self, image: "ingest_api_DockerImageSource", inputs: List["ingest_api_FileExtractionInput"], labels: List[str], name: str, properties: Dict[str, str], timestamp_metadata: "ingest_api_TimestampMetadata", workspace: str, description: Optional[str] = None, output_file_format: Optional["ingest_api_FileOutputFormat"] = None) -> None:
+    def __init__(self, image: "ingest_api_DockerImageSource", inputs: List["ingest_api_FileExtractionInput"], labels: List[str], name: str, parameters: List["ingest_api_FileExtractionParameter"], properties: Dict[str, str], timestamp_metadata: "ingest_api_TimestampMetadata", workspace: str, description: Optional[str] = None, output_file_format: Optional["ingest_api_FileOutputFormat"] = None) -> None:
         self._name = name
         self._description = description
         self._image = image
         self._inputs = inputs
+        self._parameters = parameters
         self._properties = properties
         self._labels = labels
         self._workspace = workspace
@@ -12255,6 +12322,12 @@ class ingest_api_RegisterContainerizedExtractorRequest(ConjureBeanType):
         """
         return self._inputs
 
+    @builtins.property
+    def parameters(self) -> List["ingest_api_FileExtractionParameter"]:
+        """Describes the parameters of the extractor.
+        """
+        return self._parameters
+
     @builtins.property
     def properties(self) -> Dict[str, str]:
         return self._properties
@@ -13024,6 +13097,7 @@ class ingest_api_UpdateContainerizedExtractorRequest(ConjureBeanType):
             'name': ConjureFieldDefinition('name', OptionalTypeWrapper[str]),
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'inputs': ConjureFieldDefinition('inputs', OptionalTypeWrapper[List[ingest_api_FileExtractionInput]]),
+            'parameters': ConjureFieldDefinition('parameters', OptionalTypeWrapper[List[ingest_api_FileExtractionParameter]]),
             'properties': ConjureFieldDefinition('properties', OptionalTypeWrapper[Dict[api_PropertyName, api_PropertyValue]]),
             'labels': ConjureFieldDefinition('labels', OptionalTypeWrapper[List[api_Label]]),
             'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[ingest_api_TimestampMetadata]),
@@ -13034,12 +13108,13 @@ class ingest_api_UpdateContainerizedExtractorRequest(ConjureBeanType):
             'command': ConjureFieldDefinition('command', OptionalTypeWrapper[str])
         }
 
-    __slots__: List[str] = ['_name', '_description', '_inputs', '_properties', '_labels', '_timestamp_metadata', '_output_file_format', '_tags', '_default_tag', '_authentication', '_command']
+    __slots__: List[str] = ['_name', '_description', '_inputs', '_parameters', '_properties', '_labels', '_timestamp_metadata', '_output_file_format', '_tags', '_default_tag', '_authentication', '_command']
 
-    def __init__(self, authentication: Optional["ingest_api_Authentication"] = None, command: Optional[str] = None, default_tag: Optional[str] = None, description: Optional[str] = None, inputs: Optional[List["ingest_api_FileExtractionInput"]] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, output_file_format: Optional["ingest_api_FileOutputFormat"] = None, properties: Optional[Dict[str, str]] = None, tags: Optional[List[str]] = None, timestamp_metadata: Optional["ingest_api_TimestampMetadata"] = None) -> None:
+    def __init__(self, authentication: Optional["ingest_api_Authentication"] = None, command: Optional[str] = None, default_tag: Optional[str] = None, description: Optional[str] = None, inputs: Optional[List["ingest_api_FileExtractionInput"]] = None, labels: Optional[List[str]] = None, name: Optional[str] = None, output_file_format: Optional["ingest_api_FileOutputFormat"] = None, parameters: Optional[List["ingest_api_FileExtractionParameter"]] = None, properties: Optional[Dict[str, str]] = None, tags: Optional[List[str]] = None, timestamp_metadata: Optional["ingest_api_TimestampMetadata"] = None) -> None:
         self._name = name
         self._description = description
         self._inputs = inputs
+        self._parameters = parameters
         self._properties = properties
         self._labels = labels
         self._timestamp_metadata = timestamp_metadata
@@ -13061,6 +13136,10 @@ class ingest_api_UpdateContainerizedExtractorRequest(ConjureBeanType):
     def inputs(self) -> Optional[List["ingest_api_FileExtractionInput"]]:
         return self._inputs
 
+    @builtins.property
+    def parameters(self) -> Optional[List["ingest_api_FileExtractionParameter"]]:
+        return self._parameters
+
     @builtins.property
     def properties(self) -> Optional[Dict[str, str]]:
         return self._properties
@@ -13424,12 +13503,13 @@ class ingest_workflow_api_EnsureExtractorJobCreatedRequest(ConjureBeanType):
             'tag': ConjureFieldDefinition('tag', str),
             '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])
+            'image_pull_secret_name': ConjureFieldDefinition('imagePullSecretName', OptionalTypeWrapper[str]),
+            'arguments': ConjureFieldDefinition('arguments', Dict[ingest_api_EnvironmentVariable, str])
         }
 
-    __slots__: List[str] = ['_bearer_token', '_workspace_rid', '_ingest_job_uuid', '_containerized_extractor', '_tag', '_validated_file_inputs', '_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', '_arguments']
 
-    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:
+    def __init__(self, arguments: Dict[str, str], 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
@@ -13438,6 +13518,7 @@ class ingest_workflow_api_EnsureExtractorJobCreatedRequest(ConjureBeanType):
         self._validated_file_inputs = validated_file_inputs
         self._multipart_upload_details = multipart_upload_details
         self._image_pull_secret_name = image_pull_secret_name
+        self._arguments = arguments
 
     @builtins.property
     def bearer_token(self) -> str:
@@ -13473,6 +13554,12 @@ class ingest_workflow_api_EnsureExtractorJobCreatedRequest(ConjureBeanType):
         """
         return self._image_pull_secret_name
 
+    @builtins.property
+    def arguments(self) -> Dict[str, str]:
+        """Additional arguments to pass as environment variables to the container.
+        """
+        return self._arguments
+
 
 ingest_workflow_api_EnsureExtractorJobCreatedRequest.__name__ = "EnsureExtractorJobCreatedRequest"
 ingest_workflow_api_EnsureExtractorJobCreatedRequest.__qualname__ = "EnsureExtractorJobCreatedRequest"

{nominal_api-0.938.0 → nominal_api-0.940.0}/nominal_api/ingest_api/__init__.py

@@ -29,6 +29,7 @@ from .._impl import (
     ingest_api_ExistingDatasetIngestDestination as ExistingDatasetIngestDestination,
     ingest_api_ExistingVideoIngestDestination as ExistingVideoIngestDestination,
     ingest_api_FileExtractionInput as FileExtractionInput,
+    ingest_api_FileExtractionParameter as FileExtractionParameter,
     ingest_api_FileFilter as FileFilter,
     ingest_api_FileFilterVisitor as FileFilterVisitor,
     ingest_api_FileOutputFormat as FileOutputFormat,
@@ -157,6 +158,7 @@ __all__ = [
     'ExistingDatasetIngestDestination',
     'ExistingVideoIngestDestination',
     'FileExtractionInput',
+    'FileExtractionParameter',
     'FileFilter',
     'FileFilterVisitor',
     'FileOutputFormat',

{nominal_api-0.938.0 → nominal_api-0.940.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.938.0 → nominal_api-0.940.0}/setup.py

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