nominal-api 0.528.0__tar.gz → 0.530.0__tar.gz

{nominal_api-0.528.0 → nominal_api-0.530.0}/PKG-INFO

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

{nominal_api-0.528.0 → nominal_api-0.530.0}/nominal_api/__init__.py

@@ -68,5 +68,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.528.0"
+__version__ = "0.530.0"
 

{nominal_api-0.528.0 → nominal_api-0.530.0}/nominal_api/_impl.py

@@ -3522,18 +3522,28 @@ class datasource_api_BatchGetChannelPrefixTreeRequest(ConjureBeanType):
     @builtins.classmethod
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            'data_source_rids': ConjureFieldDefinition('dataSourceRids', List[api_rids_DataSourceRid])
+            'data_source_rids': ConjureFieldDefinition('dataSourceRids', List[api_rids_DataSourceRid]),
+            'data_scope_filters': ConjureFieldDefinition('dataScopeFilters', OptionalTypeWrapper[datasource_api_DataScopeFilters])
         }
 
-    __slots__: List[str] = ['_data_source_rids']
+    __slots__: List[str] = ['_data_source_rids', '_data_scope_filters']
 
-    def __init__(self, data_source_rids: List[str]) -> None:
+    def __init__(self, data_source_rids: List[str], data_scope_filters: Optional["datasource_api_DataScopeFilters"] = None) -> None:
         self._data_source_rids = data_source_rids
+        self._data_scope_filters = data_scope_filters
 
     @builtins.property
     def data_source_rids(self) -> List[str]:
         return self._data_source_rids
 
+    @builtins.property
+    def data_scope_filters(self) -> Optional["datasource_api_DataScopeFilters"]:
+        """
+        When dataScopeFilters are specified, the set of data sources must match the set of data sources in
+DataScopeFilters#tags
+        """
+        return self._data_scope_filters
+
 
 datasource_api_BatchGetChannelPrefixTreeRequest.__name__ = "BatchGetChannelPrefixTreeRequest"
 datasource_api_BatchGetChannelPrefixTreeRequest.__qualname__ = "BatchGetChannelPrefixTreeRequest"
@@ -3831,6 +3841,51 @@ datasource_api_ChannelWithTagFilters.__qualname__ = "ChannelWithTagFilters"
 datasource_api_ChannelWithTagFilters.__module__ = "nominal_api.datasource_api"
 
 
+class datasource_api_DataScopeFilters(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'tags': ConjureFieldDefinition('tags', Dict[api_rids_DataSourceRid, Dict[api_TagName, api_TagValue]]),
+            'min_data_updated_time': ConjureFieldDefinition('minDataUpdatedTime', scout_run_api_UtcTimestamp),
+            'max_data_start_time': ConjureFieldDefinition('maxDataStartTime', scout_run_api_UtcTimestamp)
+        }
+
+    __slots__: List[str] = ['_tags', '_min_data_updated_time', '_max_data_start_time']
+
+    def __init__(self, max_data_start_time: "scout_run_api_UtcTimestamp", min_data_updated_time: "scout_run_api_UtcTimestamp", tags: Dict[str, Dict[str, str]]) -> None:
+        self._tags = tags
+        self._min_data_updated_time = min_data_updated_time
+        self._max_data_start_time = max_data_start_time
+
+    @builtins.property
+    def tags(self) -> Dict[str, Dict[str, str]]:
+        """
+        For each data source specified as a key, search will only return channels containing a superset of the 
+tags specified for that given datasource.
+        """
+        return self._tags
+
+    @builtins.property
+    def min_data_updated_time(self) -> "scout_run_api_UtcTimestamp":
+        """
+        Will only return channels that have had new data after the specified time.
+        """
+        return self._min_data_updated_time
+
+    @builtins.property
+    def max_data_start_time(self) -> "scout_run_api_UtcTimestamp":
+        """
+        Will only return channels that have data before the specified time.
+        """
+        return self._max_data_start_time
+
+
+datasource_api_DataScopeFilters.__name__ = "DataScopeFilters"
+datasource_api_DataScopeFilters.__qualname__ = "DataScopeFilters"
+datasource_api_DataScopeFilters.__module__ = "nominal_api.datasource_api"
+
+
 class datasource_api_DataSourcePrefixNode(ConjureBeanType):
 
     @builtins.classmethod
@@ -4155,14 +4210,16 @@ class datasource_api_SearchHierarchicalChannelsRequest(ConjureBeanType):
     def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'parent': ConjureFieldDefinition('parent', List[str]),
-            'data_sources': ConjureFieldDefinition('dataSources', List[api_rids_DataSourceRid])
+            'data_sources': ConjureFieldDefinition('dataSources', List[api_rids_DataSourceRid]),
+            'data_scope_filters': ConjureFieldDefinition('dataScopeFilters', OptionalTypeWrapper[datasource_api_DataScopeFilters])
         }
 
-    __slots__: List[str] = ['_parent', '_data_sources']
+    __slots__: List[str] = ['_parent', '_data_sources', '_data_scope_filters']
 
-    def __init__(self, data_sources: List[str], parent: List[str]) -> None:
+    def __init__(self, data_sources: List[str], parent: List[str], data_scope_filters: Optional["datasource_api_DataScopeFilters"] = None) -> None:
         self._parent = parent
         self._data_sources = data_sources
+        self._data_scope_filters = data_scope_filters
 
     @builtins.property
     def parent(self) -> List[str]:
@@ -4175,6 +4232,14 @@ class datasource_api_SearchHierarchicalChannelsRequest(ConjureBeanType):
     def data_sources(self) -> List[str]:
         return self._data_sources
 
+    @builtins.property
+    def data_scope_filters(self) -> Optional["datasource_api_DataScopeFilters"]:
+        """
+        When dataScopeFilters are specified, the set of data sources must match the set of data sources in
+DataScopeFilters#tags
+        """
+        return self._data_scope_filters
+
 
 datasource_api_SearchHierarchicalChannelsRequest.__name__ = "SearchHierarchicalChannelsRequest"
 datasource_api_SearchHierarchicalChannelsRequest.__qualname__ = "SearchHierarchicalChannelsRequest"
@@ -5645,6 +5710,7 @@ event_SearchEventsResponse.__module__ = "nominal_api.event"
 
 
 class event_SearchQuery(ConjureUnionType):
+    _search_text: Optional[str] = None
     _after: Optional["api_Timestamp"] = None
     _before: Optional["api_Timestamp"] = None
     _asset: Optional[str] = None
@@ -5656,6 +5722,7 @@ class event_SearchQuery(ConjureUnionType):
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
+            'search_text': ConjureFieldDefinition('searchText', str),
             'after': ConjureFieldDefinition('after', api_Timestamp),
             'before': ConjureFieldDefinition('before', api_Timestamp),
             'asset': ConjureFieldDefinition('asset', scout_rids_api_AssetRid),
@@ -5667,6 +5734,7 @@ class event_SearchQuery(ConjureUnionType):
 
     def __init__(
             self,
+            search_text: Optional[str] = None,
             after: Optional["api_Timestamp"] = None,
             before: Optional["api_Timestamp"] = None,
             asset: Optional[str] = None,
@@ -5677,9 +5745,12 @@ class event_SearchQuery(ConjureUnionType):
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (after is not None) + (before is not None) + (asset is not None) + (label is not None) + (property is not None) + (and_ is not None) + (or_ is not None) != 1:
+            if (search_text is not None) + (after is not None) + (before is not None) + (asset is not None) + (label is not None) + (property is not None) + (and_ is not None) + (or_ is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
+            if search_text is not None:
+                self._search_text = search_text
+                self._type = 'searchText'
             if after is not None:
                 self._after = after
                 self._type = 'after'
@@ -5702,6 +5773,11 @@ class event_SearchQuery(ConjureUnionType):
                 self._or_ = or_
                 self._type = 'or'
 
+        elif type_of_union == 'searchText':
+            if search_text is None:
+                raise ValueError('a union value must not be None')
+            self._search_text = search_text
+            self._type = 'searchText'
         elif type_of_union == 'after':
             if after is None:
                 raise ValueError('a union value must not be None')
@@ -5738,10 +5814,14 @@ class event_SearchQuery(ConjureUnionType):
             self._or_ = or_
             self._type = 'or'
 
+    @builtins.property
+    def search_text(self) -> Optional[str]:
+        return self._search_text
+
     @builtins.property
     def after(self) -> Optional["api_Timestamp"]:
         """
-        Filters to start times after this time, inclusive.
+        Filters to end times after this time, exclusive.
         """
         return self._after
 
@@ -5775,6 +5855,8 @@ class event_SearchQuery(ConjureUnionType):
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, event_SearchQueryVisitor):
             raise ValueError('{} is not an instance of event_SearchQueryVisitor'.format(visitor.__class__.__name__))
+        if self._type == 'searchText' and self.search_text is not None:
+            return visitor._search_text(self.search_text)
         if self._type == 'after' and self.after is not None:
             return visitor._after(self.after)
         if self._type == 'before' and self.before is not None:
@@ -5798,6 +5880,10 @@ event_SearchQuery.__module__ = "nominal_api.event"
 
 class event_SearchQueryVisitor:
 
+    @abstractmethod
+    def _search_text(self, search_text: str) -> Any:
+        pass
+
     @abstractmethod
     def _after(self, after: "api_Timestamp") -> Any:
         pass
@@ -6136,16 +6222,18 @@ class ingest_api_CsvOpts(ConjureBeanType):
             'source': ConjureFieldDefinition('source', ingest_api_IngestSource),
             'target': ConjureFieldDefinition('target', ingest_api_DatasetIngestTarget),
             'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', ingest_api_TimestampMetadata),
+            'channel_prefix': ConjureFieldDefinition('channelPrefix', ingest_api_ChannelPrefix),
             'tag_keys_from_columns': ConjureFieldDefinition('tagKeysFromColumns', OptionalTypeWrapper[List[api_TagName]]),
             'additional_file_tags': ConjureFieldDefinition('additionalFileTags', OptionalTypeWrapper[Dict[api_TagName, api_TagValue]])
         }
 
-    __slots__: List[str] = ['_source', '_target', '_timestamp_metadata', '_tag_keys_from_columns', '_additional_file_tags']
+    __slots__: List[str] = ['_source', '_target', '_timestamp_metadata', '_channel_prefix', '_tag_keys_from_columns', '_additional_file_tags']
 
-    def __init__(self, source: "ingest_api_IngestSource", target: "ingest_api_DatasetIngestTarget", timestamp_metadata: "ingest_api_TimestampMetadata", additional_file_tags: Optional[Dict[str, str]] = None, tag_keys_from_columns: Optional[List[str]] = None) -> None:
+    def __init__(self, source: "ingest_api_IngestSource", target: "ingest_api_DatasetIngestTarget", timestamp_metadata: "ingest_api_TimestampMetadata", additional_file_tags: Optional[Dict[str, str]] = None, channel_prefix: Optional[str] = None, tag_keys_from_columns: Optional[List[str]] = None) -> None:
         self._source = source
         self._target = target
         self._timestamp_metadata = timestamp_metadata
+        self._channel_prefix = channel_prefix
         self._tag_keys_from_columns = tag_keys_from_columns
         self._additional_file_tags = additional_file_tags
 
@@ -6161,6 +6249,10 @@ class ingest_api_CsvOpts(ConjureBeanType):
     def timestamp_metadata(self) -> "ingest_api_TimestampMetadata":
         return self._timestamp_metadata
 
+    @builtins.property
+    def channel_prefix(self) -> Optional[str]:
+        return self._channel_prefix
+
     @builtins.property
     def tag_keys_from_columns(self) -> Optional[List[str]]:
         return self._tag_keys_from_columns
@@ -6596,6 +6688,29 @@ ingest_api_ExistingDatasetIngestDestination.__qualname__ = "ExistingDatasetInges
 ingest_api_ExistingDatasetIngestDestination.__module__ = "nominal_api.ingest_api"
 
 
+class ingest_api_GcsIngestSource(ConjureBeanType):
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+            'path': ConjureFieldDefinition('path', str)
+        }
+
+    __slots__: List[str] = ['_path']
+
+    def __init__(self, path: str) -> None:
+        self._path = path
+
+    @builtins.property
+    def path(self) -> str:
+        return self._path
+
+
+ingest_api_GcsIngestSource.__name__ = "GcsIngestSource"
+ingest_api_GcsIngestSource.__qualname__ = "GcsIngestSource"
+ingest_api_GcsIngestSource.__module__ = "nominal_api.ingest_api"
+
+
 class ingest_api_InProgressResult(ConjureBeanType):
 
     @builtins.classmethod
@@ -6900,7 +7015,7 @@ class ingest_api_IngestMcapRequest(ConjureBeanType):
     @builtins.property
     def sources(self) -> List["ingest_api_IngestSource"]:
         """
-        List of files in S3 to be ingested. These should be ordered by time, as data will be ingested and 
+        List of files in S3 to be ingested. These should be ordered by time, as data will be ingested and
 concatenated across all the files.
 Note: only a single files are currently supported, this field is mostly for forward compatibility.
         """
@@ -7559,41 +7674,58 @@ ingest_api_IngestService.__module__ = "nominal_api.ingest_api"
 
 class ingest_api_IngestSource(ConjureUnionType):
     _s3: Optional["ingest_api_S3IngestSource"] = None
+    _gcs: Optional["ingest_api_GcsIngestSource"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
-            's3': ConjureFieldDefinition('s3', ingest_api_S3IngestSource)
+            's3': ConjureFieldDefinition('s3', ingest_api_S3IngestSource),
+            'gcs': ConjureFieldDefinition('gcs', ingest_api_GcsIngestSource)
         }
 
     def __init__(
             self,
             s3: Optional["ingest_api_S3IngestSource"] = None,
+            gcs: Optional["ingest_api_GcsIngestSource"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (s3 is not None) != 1:
+            if (s3 is not None) + (gcs is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if s3 is not None:
                 self._s3 = s3
                 self._type = 's3'
+            if gcs is not None:
+                self._gcs = gcs
+                self._type = 'gcs'
 
         elif type_of_union == 's3':
             if s3 is None:
                 raise ValueError('a union value must not be None')
             self._s3 = s3
             self._type = 's3'
+        elif type_of_union == 'gcs':
+            if gcs is None:
+                raise ValueError('a union value must not be None')
+            self._gcs = gcs
+            self._type = 'gcs'
 
     @builtins.property
     def s3(self) -> Optional["ingest_api_S3IngestSource"]:
         return self._s3
 
+    @builtins.property
+    def gcs(self) -> Optional["ingest_api_GcsIngestSource"]:
+        return self._gcs
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, ingest_api_IngestSourceVisitor):
             raise ValueError('{} is not an instance of ingest_api_IngestSourceVisitor'.format(visitor.__class__.__name__))
         if self._type == 's3' and self.s3 is not None:
             return visitor._s3(self.s3)
+        if self._type == 'gcs' and self.gcs is not None:
+            return visitor._gcs(self.gcs)
 
 
 ingest_api_IngestSource.__name__ = "IngestSource"
@@ -7607,6 +7739,10 @@ class ingest_api_IngestSourceVisitor:
     def _s3(self, s3: "ingest_api_S3IngestSource") -> Any:
         pass
 
+    @abstractmethod
+    def _gcs(self, gcs: "ingest_api_GcsIngestSource") -> Any:
+        pass
+
 
 ingest_api_IngestSourceVisitor.__name__ = "IngestSourceVisitor"
 ingest_api_IngestSourceVisitor.__qualname__ = "IngestSourceVisitor"
@@ -9066,7 +9202,7 @@ ingest_api_TimeOffsetSpecVisitor.__module__ = "nominal_api.ingest_api"
 
 class ingest_api_TimestampManifest(ConjureBeanType):
     """
-    The timestamp manifest files will contain a list of absolute timestamps, in nanoseconds, that correspond to 
+    The timestamp manifest files will contain a list of absolute timestamps, in nanoseconds, that correspond to
 each frame in a video. Each file should be of type JSON and store a single list, the length of which equals
 the number of frames in its corresponding video.
     """
@@ -49327,7 +49463,7 @@ The Connection Service is responsible for creating, updating, and retrieving dat
         _decoder = ConjureDecoder()
         return _decoder.decode(_response.json(), List[scout_datasource_connection_api_Connection], self._return_none_for_unknown_union_types)
 
-    def list_connections(self, auth_header: str) -> List["scout_datasource_connection_api_Connection"]:
+    def list_connections(self, auth_header: str, include_archived: Optional[bool] = None) -> List["scout_datasource_connection_api_Connection"]:
         """
         Lists all connections.
         """
@@ -49338,6 +49474,7 @@ The Connection Service is responsible for creating, updating, and retrieving dat
         }
 
         _params: Dict[str, Any] = {
+            'includeArchived': include_archived,
         }
 
         _path_params: Dict[str, Any] = {
@@ -67671,6 +67808,8 @@ authorization_ApiKeyRid = str
 
 scout_rids_api_ApiKeyRid = str
 
+ingest_api_ChannelPrefix = OptionalTypeWrapper[str]
+
 scout_rids_api_AssetRid = str
 
 comments_api_CommentRid = str

{nominal_api-0.528.0 → nominal_api-0.530.0}/nominal_api/datasource_api/__init__.py

@@ -9,6 +9,7 @@ from .._impl import (
     datasource_api_ChannelPrefixTreeNode as ChannelPrefixTreeNode,
     datasource_api_ChannelWithAvailableTags as ChannelWithAvailableTags,
     datasource_api_ChannelWithTagFilters as ChannelWithTagFilters,
+    datasource_api_DataScopeFilters as DataScopeFilters,
     datasource_api_DataSourcePrefixNode as DataSourcePrefixNode,
     datasource_api_GetAvailableTagsForChannelRequest as GetAvailableTagsForChannelRequest,
     datasource_api_GetAvailableTagsForChannelResponse as GetAvailableTagsForChannelResponse,

{nominal_api-0.528.0 → nominal_api-0.530.0}/nominal_api/ingest_api/__init__.py

@@ -4,6 +4,7 @@ from .._impl import (
     ingest_api_AbsoluteTimestampVisitor as AbsoluteTimestampVisitor,
     ingest_api_AsyncHandle as AsyncHandle,
     ingest_api_ChannelConfig as ChannelConfig,
+    ingest_api_ChannelPrefix as ChannelPrefix,
     ingest_api_CompleteMultipartUploadResponse as CompleteMultipartUploadResponse,
     ingest_api_CsvOpts as CsvOpts,
     ingest_api_CustomTimestamp as CustomTimestamp,
@@ -21,6 +22,7 @@ from .._impl import (
     ingest_api_ErrorResult as ErrorResult,
     ingest_api_ErrorType as ErrorType,
     ingest_api_ExistingDatasetIngestDestination as ExistingDatasetIngestDestination,
+    ingest_api_GcsIngestSource as GcsIngestSource,
     ingest_api_InProgressResult as InProgressResult,
     ingest_api_IngestDataSource as IngestDataSource,
     ingest_api_IngestDataSourceVisitor as IngestDataSourceVisitor,

{nominal_api-0.528.0 → nominal_api-0.530.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.528.0 → nominal_api-0.530.0}/setup.py

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