nominal-api 0.587.0__tar.gz → 0.588.0__tar.gz

{nominal_api-0.587.0 → nominal_api-0.588.0}/PKG-INFO

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

{nominal_api-0.587.0 → nominal_api-0.588.0}/nominal_api/__init__.py

@@ -74,5 +74,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.587.0"
+__version__ = "0.588.0"
 

{nominal_api-0.587.0 → nominal_api-0.588.0}/nominal_api/_impl.py

@@ -6825,16 +6825,18 @@ class ingest_api_DeprecatedTriggerIngest(ConjureBeanType):
             'source': ConjureFieldDefinition('source', ingest_api_IngestSource),
             'properties': ConjureFieldDefinition('properties', Dict[str, str]),
             'dataset_name': ConjureFieldDefinition('datasetName', OptionalTypeWrapper[str]),
-            'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[ingest_api_DeprecatedTimestampMetadata])
+            'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[ingest_api_DeprecatedTimestampMetadata]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_source', '_properties', '_dataset_name', '_timestamp_metadata']
+    __slots__: List[str] = ['_source', '_properties', '_dataset_name', '_timestamp_metadata', '_workspace']
 
-    def __init__(self, properties: Dict[str, str], source: "ingest_api_IngestSource", dataset_name: Optional[str] = None, timestamp_metadata: Optional["ingest_api_DeprecatedTimestampMetadata"] = None) -> None:
+    def __init__(self, properties: Dict[str, str], source: "ingest_api_IngestSource", dataset_name: Optional[str] = None, timestamp_metadata: Optional["ingest_api_DeprecatedTimestampMetadata"] = None, workspace: Optional[str] = None) -> None:
         self._source = source
         self._properties = properties
         self._dataset_name = dataset_name
         self._timestamp_metadata = timestamp_metadata
+        self._workspace = workspace
 
     @builtins.property
     def source(self) -> "ingest_api_IngestSource":
@@ -6852,6 +6854,14 @@ class ingest_api_DeprecatedTriggerIngest(ConjureBeanType):
     def timestamp_metadata(self) -> Optional["ingest_api_DeprecatedTimestampMetadata"]:
         return self._timestamp_metadata
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 ingest_api_DeprecatedTriggerIngest.__name__ = "DeprecatedTriggerIngest"
 ingest_api_DeprecatedTriggerIngest.__qualname__ = "DeprecatedTriggerIngest"
@@ -7254,12 +7264,13 @@ class ingest_api_IngestMcapRequest(ConjureBeanType):
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'labels': ConjureFieldDefinition('labels', List[api_Label]),
             'title': ConjureFieldDefinition('title', OptionalTypeWrapper[str]),
-            'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str])
+            'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_sources', '_channel_config', '_channels', '_properties', '_labels', '_title', '_description']
+    __slots__: List[str] = ['_sources', '_channel_config', '_channels', '_properties', '_labels', '_title', '_description', '_workspace']
 
-    def __init__(self, channel_config: List["ingest_api_McapChannelConfig"], labels: List[str], properties: Dict[str, str], sources: List["ingest_api_IngestSource"], channels: Optional["ingest_api_McapChannels"] = None, description: Optional[str] = None, title: Optional[str] = None) -> None:
+    def __init__(self, channel_config: List["ingest_api_McapChannelConfig"], labels: List[str], properties: Dict[str, str], sources: List["ingest_api_IngestSource"], channels: Optional["ingest_api_McapChannels"] = None, description: Optional[str] = None, title: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._sources = sources
         self._channel_config = channel_config
         self._channels = channels
@@ -7267,6 +7278,7 @@ class ingest_api_IngestMcapRequest(ConjureBeanType):
         self._labels = labels
         self._title = title
         self._description = description
+        self._workspace = workspace
 
     @builtins.property
     def sources(self) -> List["ingest_api_IngestSource"]:
@@ -7305,6 +7317,14 @@ channels with config, otherwise the mcap may not be supported.
     def description(self) -> Optional[str]:
         return self._description
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 ingest_api_IngestMcapRequest.__name__ = "IngestMcapRequest"
 ingest_api_IngestMcapRequest.__qualname__ = "IngestMcapRequest"
@@ -7624,12 +7644,13 @@ class ingest_api_IngestRunRequest(ConjureBeanType):
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'labels': ConjureFieldDefinition('labels', List[api_Label]),
             'run_prefix': ConjureFieldDefinition('runPrefix', OptionalTypeWrapper[str]),
-            'data_sources': ConjureFieldDefinition('dataSources', Dict[ingest_api_DataSourceRefName, ingest_api_IngestRunDataSource])
+            'data_sources': ConjureFieldDefinition('dataSources', Dict[ingest_api_DataSourceRefName, ingest_api_IngestRunDataSource]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_rid', '_title', '_description', '_start_time', '_end_time', '_properties', '_labels', '_run_prefix', '_data_sources']
+    __slots__: List[str] = ['_rid', '_title', '_description', '_start_time', '_end_time', '_properties', '_labels', '_run_prefix', '_data_sources', '_workspace']
 
-    def __init__(self, data_sources: Dict[str, "ingest_api_IngestRunDataSource"], description: str, labels: List[str], properties: Dict[str, str], start_time: "ingest_api_UtcTimestamp", title: str, end_time: Optional["ingest_api_UtcTimestamp"] = None, rid: Optional[str] = None, run_prefix: Optional[str] = None) -> None:
+    def __init__(self, data_sources: Dict[str, "ingest_api_IngestRunDataSource"], description: str, labels: List[str], properties: Dict[str, str], start_time: "ingest_api_UtcTimestamp", title: str, end_time: Optional["ingest_api_UtcTimestamp"] = None, rid: Optional[str] = None, run_prefix: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._rid = rid
         self._title = title
         self._description = description
@@ -7639,6 +7660,7 @@ class ingest_api_IngestRunRequest(ConjureBeanType):
         self._labels = labels
         self._run_prefix = run_prefix
         self._data_sources = data_sources
+        self._workspace = workspace
 
     @builtins.property
     def rid(self) -> Optional[str]:
@@ -7682,6 +7704,14 @@ class ingest_api_IngestRunRequest(ConjureBeanType):
     def data_sources(self) -> Dict[str, "ingest_api_IngestRunDataSource"]:
         return self._data_sources
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 ingest_api_IngestRunRequest.__name__ = "IngestRunRequest"
 ingest_api_IngestRunRequest.__qualname__ = "IngestRunRequest"
@@ -7912,7 +7942,6 @@ existing one.
     def ingest_mcap(self, auth_header: str, ingest_video: "ingest_api_IngestMcapRequest") -> "ingest_api_IngestMcapResponse":
         """
         Ingests data from mcap files in the S3 Nominal upload bucket.
-Currently only supports ingesting video channels.
         """
 
         _headers: Dict[str, Any] = {
@@ -8897,17 +8926,19 @@ class ingest_api_NewDatasetIngestDestination(ConjureBeanType):
             'dataset_description': ConjureFieldDefinition('datasetDescription', OptionalTypeWrapper[str]),
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'labels': ConjureFieldDefinition('labels', List[api_Label]),
-            'channel_config': ConjureFieldDefinition('channelConfig', OptionalTypeWrapper[ingest_api_ChannelConfig])
+            'channel_config': ConjureFieldDefinition('channelConfig', OptionalTypeWrapper[ingest_api_ChannelConfig]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_dataset_name', '_dataset_description', '_properties', '_labels', '_channel_config']
+    __slots__: List[str] = ['_dataset_name', '_dataset_description', '_properties', '_labels', '_channel_config', '_workspace']
 
-    def __init__(self, labels: List[str], properties: Dict[str, str], channel_config: Optional["ingest_api_ChannelConfig"] = None, dataset_description: Optional[str] = None, dataset_name: Optional[str] = None) -> None:
+    def __init__(self, labels: List[str], properties: Dict[str, str], channel_config: Optional["ingest_api_ChannelConfig"] = None, dataset_description: Optional[str] = None, dataset_name: Optional[str] = None, workspace: Optional[str] = None) -> None:
         self._dataset_name = dataset_name
         self._dataset_description = dataset_description
         self._properties = properties
         self._labels = labels
         self._channel_config = channel_config
+        self._workspace = workspace
 
     @builtins.property
     def dataset_name(self) -> Optional[str]:
@@ -8929,6 +8960,14 @@ class ingest_api_NewDatasetIngestDestination(ConjureBeanType):
     def channel_config(self) -> Optional["ingest_api_ChannelConfig"]:
         return self._channel_config
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 ingest_api_NewDatasetIngestDestination.__name__ = "NewDatasetIngestDestination"
 ingest_api_NewDatasetIngestDestination.__qualname__ = "NewDatasetIngestDestination"
@@ -9558,12 +9597,13 @@ class ingest_api_TriggerIngest(ConjureBeanType):
             'dataset_name': ConjureFieldDefinition('datasetName', OptionalTypeWrapper[str]),
             'dataset_description': ConjureFieldDefinition('datasetDescription', OptionalTypeWrapper[str]),
             'timestamp_metadata': ConjureFieldDefinition('timestampMetadata', OptionalTypeWrapper[ingest_api_TimestampMetadata]),
-            'channel_config': ConjureFieldDefinition('channelConfig', OptionalTypeWrapper[ingest_api_ChannelConfig])
+            'channel_config': ConjureFieldDefinition('channelConfig', OptionalTypeWrapper[ingest_api_ChannelConfig]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_source', '_properties', '_labels', '_dataset_name', '_dataset_description', '_timestamp_metadata', '_channel_config']
+    __slots__: List[str] = ['_source', '_properties', '_labels', '_dataset_name', '_dataset_description', '_timestamp_metadata', '_channel_config', '_workspace']
 
-    def __init__(self, labels: List[str], properties: Dict[str, str], source: "ingest_api_IngestSource", channel_config: Optional["ingest_api_ChannelConfig"] = None, dataset_description: Optional[str] = None, dataset_name: Optional[str] = None, timestamp_metadata: Optional["ingest_api_TimestampMetadata"] = None) -> None:
+    def __init__(self, labels: List[str], properties: Dict[str, str], source: "ingest_api_IngestSource", channel_config: Optional["ingest_api_ChannelConfig"] = None, dataset_description: Optional[str] = None, dataset_name: Optional[str] = None, timestamp_metadata: Optional["ingest_api_TimestampMetadata"] = None, workspace: Optional[str] = None) -> None:
         self._source = source
         self._properties = properties
         self._labels = labels
@@ -9571,6 +9611,7 @@ class ingest_api_TriggerIngest(ConjureBeanType):
         self._dataset_description = dataset_description
         self._timestamp_metadata = timestamp_metadata
         self._channel_config = channel_config
+        self._workspace = workspace
 
     @builtins.property
     def source(self) -> "ingest_api_IngestSource":
@@ -9603,6 +9644,14 @@ class ingest_api_TriggerIngest(ConjureBeanType):
         """
         return self._channel_config
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 ingest_api_TriggerIngest.__name__ = "TriggerIngest"
 ingest_api_TriggerIngest.__qualname__ = "TriggerIngest"
@@ -14808,7 +14857,8 @@ dataset can still be directly accessed by its UUID/rid.
 
         return
 
-    def get_all_properties_and_labels(self, auth_header: str) -> "scout_catalog_AllPropertiesAndLabelsResponse":
+    def get_all_properties_and_labels(self, auth_header: str, workspaces: List[str] = None) -> "scout_catalog_AllPropertiesAndLabelsResponse":
+        workspaces = workspaces if workspaces is not None else []
 
         _headers: Dict[str, Any] = {
             'Accept': 'application/json',
@@ -14816,6 +14866,7 @@ dataset can still be directly accessed by its UUID/rid.
         }
 
         _params: Dict[str, Any] = {
+            'workspaces': workspaces,
         }
 
         _path_params: Dict[str, Any] = {
@@ -14969,12 +15020,13 @@ class scout_catalog_CreateDataset(ConjureBeanType):
             'properties': ConjureFieldDefinition('properties', Dict[api_PropertyName, api_PropertyValue]),
             'description': ConjureFieldDefinition('description', OptionalTypeWrapper[str]),
             'granularity': ConjureFieldDefinition('granularity', OptionalTypeWrapper[api_Granularity]),
-            'is_v2_dataset': ConjureFieldDefinition('isV2Dataset', OptionalTypeWrapper[bool])
+            'is_v2_dataset': ConjureFieldDefinition('isV2Dataset', OptionalTypeWrapper[bool]),
+            'workspace': ConjureFieldDefinition('workspace', OptionalTypeWrapper[api_ids_WorkspaceId])
         }
 
-    __slots__: List[str] = ['_name', '_handle', '_metadata', '_origin_metadata', '_labels', '_properties', '_description', '_granularity', '_is_v2_dataset']
+    __slots__: List[str] = ['_name', '_handle', '_metadata', '_origin_metadata', '_labels', '_properties', '_description', '_granularity', '_is_v2_dataset', '_workspace']
 
-    def __init__(self, labels: List[str], metadata: Dict[str, str], name: str, origin_metadata: "scout_catalog_DatasetOriginMetadata", properties: Dict[str, str], description: Optional[str] = None, granularity: Optional["api_Granularity"] = None, handle: Optional["scout_catalog_Handle"] = None, is_v2_dataset: Optional[bool] = None) -> None:
+    def __init__(self, labels: List[str], metadata: Dict[str, str], name: str, origin_metadata: "scout_catalog_DatasetOriginMetadata", properties: Dict[str, str], description: Optional[str] = None, granularity: Optional["api_Granularity"] = None, handle: Optional["scout_catalog_Handle"] = None, is_v2_dataset: Optional[bool] = None, workspace: Optional[str] = None) -> None:
         self._name = name
         self._handle = handle
         self._metadata = metadata
@@ -14984,6 +15036,7 @@ class scout_catalog_CreateDataset(ConjureBeanType):
         self._description = description
         self._granularity = granularity
         self._is_v2_dataset = is_v2_dataset
+        self._workspace = workspace
 
     @builtins.property
     def name(self) -> str:
@@ -15023,10 +15076,18 @@ class scout_catalog_CreateDataset(ConjureBeanType):
     @builtins.property
     def is_v2_dataset(self) -> Optional[bool]:
         """
-        If true, the dataset should be ingested to the v2 tables.
+        If true, the dataset should be ingested to the v2 tables and is compatible with streaming.
         """
         return self._is_v2_dataset
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        """
+        The workspace in which to create the dataset. If not provided, the dataset will be created in the default workspace for
+the user's organization, if the default workspace for the organization is configured.
+        """
+        return self._workspace
+
 
 scout_catalog_CreateDataset.__name__ = "CreateDataset"
 scout_catalog_CreateDataset.__qualname__ = "CreateDataset"
@@ -16216,6 +16277,7 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
     _archive_status: Optional[bool] = None
     _and_: Optional[List["scout_catalog_SearchDatasetsQuery"]] = None
     _or_: Optional[List["scout_catalog_SearchDatasetsQuery"]] = None
+    _workspace: Optional[str] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
@@ -16229,7 +16291,8 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
             'ingested_after_inclusive': ConjureFieldDefinition('ingestedAfterInclusive', str),
             'archive_status': ConjureFieldDefinition('archiveStatus', bool),
             'and_': ConjureFieldDefinition('and', List[scout_catalog_SearchDatasetsQuery]),
-            'or_': ConjureFieldDefinition('or', List[scout_catalog_SearchDatasetsQuery])
+            'or_': ConjureFieldDefinition('or', List[scout_catalog_SearchDatasetsQuery]),
+            'workspace': ConjureFieldDefinition('workspace', api_ids_WorkspaceId)
         }
 
     def __init__(
@@ -16244,10 +16307,11 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
             archive_status: Optional[bool] = None,
             and_: Optional[List["scout_catalog_SearchDatasetsQuery"]] = None,
             or_: Optional[List["scout_catalog_SearchDatasetsQuery"]] = None,
+            workspace: Optional[str] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (search_text is not None) + (exact_match is not None) + (label is not None) + (properties is not None) + (ingest_status is not None) + (ingested_before_inclusive is not None) + (ingested_after_inclusive is not None) + (archive_status is not None) + (and_ is not None) + (or_ is not None) != 1:
+            if (search_text is not None) + (exact_match is not None) + (label is not None) + (properties is not None) + (ingest_status is not None) + (ingested_before_inclusive is not None) + (ingested_after_inclusive is not None) + (archive_status is not None) + (and_ is not None) + (or_ is not None) + (workspace is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if search_text is not None:
@@ -16280,6 +16344,9 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
             if or_ is not None:
                 self._or_ = or_
                 self._type = 'or'
+            if workspace is not None:
+                self._workspace = workspace
+                self._type = 'workspace'
 
         elif type_of_union == 'searchText':
             if search_text is None:
@@ -16331,6 +16398,11 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._or_ = or_
             self._type = 'or'
+        elif type_of_union == 'workspace':
+            if workspace is None:
+                raise ValueError('a union value must not be None')
+            self._workspace = workspace
+            self._type = 'workspace'
 
     @builtins.property
     def search_text(self) -> Optional[str]:
@@ -16375,6 +16447,10 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
     def or_(self) -> Optional[List["scout_catalog_SearchDatasetsQuery"]]:
         return self._or_
 
+    @builtins.property
+    def workspace(self) -> Optional[str]:
+        return self._workspace
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, scout_catalog_SearchDatasetsQueryVisitor):
             raise ValueError('{} is not an instance of scout_catalog_SearchDatasetsQueryVisitor'.format(visitor.__class__.__name__))
@@ -16398,6 +16474,8 @@ class scout_catalog_SearchDatasetsQuery(ConjureUnionType):
             return visitor._and(self.and_)
         if self._type == 'or' and self.or_ is not None:
             return visitor._or(self.or_)
+        if self._type == 'workspace' and self.workspace is not None:
+            return visitor._workspace(self.workspace)
 
 
 scout_catalog_SearchDatasetsQuery.__name__ = "SearchDatasetsQuery"
@@ -16447,6 +16525,10 @@ class scout_catalog_SearchDatasetsQueryVisitor:
     def _or(self, or_: List["scout_catalog_SearchDatasetsQuery"]) -> Any:
         pass
 
+    @abstractmethod
+    def _workspace(self, workspace: str) -> Any:
+        pass
+
 
 scout_catalog_SearchDatasetsQueryVisitor.__name__ = "SearchDatasetsQueryVisitor"
 scout_catalog_SearchDatasetsQueryVisitor.__qualname__ = "SearchDatasetsQueryVisitor"

{nominal_api-0.587.0 → nominal_api-0.588.0}/nominal_api.egg-info/PKG-INFO

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

{nominal_api-0.587.0 → nominal_api-0.588.0}/setup.py

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