nominal-api 0.628.0__py3-none-any.whl → 0.629.0__py3-none-any.whl

nominal_api/__init__.py

@@ -76,5 +76,5 @@ __all__ = [
 
 __conjure_generator_version__ = "4.9.0"
 
-__version__ = "0.628.0"
+__version__ = "0.629.0"
 

nominal_api/_impl.py

@@ -12271,22 +12271,25 @@ persistent_compute_api_FullResult.__module__ = "nominal_api.persistent_compute_a
 class persistent_compute_api_HealthMessage(ConjureUnionType):
     _ping: Optional["persistent_compute_api_Ping"] = None
     _pong: Optional["persistent_compute_api_Pong"] = None
+    _shutdown_notice: Optional["persistent_compute_api_ShutdownNotice"] = None
 
     @builtins.classmethod
     def _options(cls) -> Dict[str, ConjureFieldDefinition]:
         return {
             'ping': ConjureFieldDefinition('ping', persistent_compute_api_Ping),
-            'pong': ConjureFieldDefinition('pong', persistent_compute_api_Pong)
+            'pong': ConjureFieldDefinition('pong', persistent_compute_api_Pong),
+            'shutdown_notice': ConjureFieldDefinition('shutdownNotice', persistent_compute_api_ShutdownNotice)
         }
 
     def __init__(
             self,
             ping: Optional["persistent_compute_api_Ping"] = None,
             pong: Optional["persistent_compute_api_Pong"] = None,
+            shutdown_notice: Optional["persistent_compute_api_ShutdownNotice"] = None,
             type_of_union: Optional[str] = None
             ) -> None:
         if type_of_union is None:
-            if (ping is not None) + (pong is not None) != 1:
+            if (ping is not None) + (pong is not None) + (shutdown_notice is not None) != 1:
                 raise ValueError('a union must contain a single member')
 
             if ping is not None:
@@ -12295,6 +12298,9 @@ class persistent_compute_api_HealthMessage(ConjureUnionType):
             if pong is not None:
                 self._pong = pong
                 self._type = 'pong'
+            if shutdown_notice is not None:
+                self._shutdown_notice = shutdown_notice
+                self._type = 'shutdownNotice'
 
         elif type_of_union == 'ping':
             if ping is None:
@@ -12306,6 +12312,11 @@ class persistent_compute_api_HealthMessage(ConjureUnionType):
                 raise ValueError('a union value must not be None')
             self._pong = pong
             self._type = 'pong'
+        elif type_of_union == 'shutdownNotice':
+            if shutdown_notice is None:
+                raise ValueError('a union value must not be None')
+            self._shutdown_notice = shutdown_notice
+            self._type = 'shutdownNotice'
 
     @builtins.property
     def ping(self) -> Optional["persistent_compute_api_Ping"]:
@@ -12315,6 +12326,10 @@ class persistent_compute_api_HealthMessage(ConjureUnionType):
     def pong(self) -> Optional["persistent_compute_api_Pong"]:
         return self._pong
 
+    @builtins.property
+    def shutdown_notice(self) -> Optional["persistent_compute_api_ShutdownNotice"]:
+        return self._shutdown_notice
+
     def accept(self, visitor) -> Any:
         if not isinstance(visitor, persistent_compute_api_HealthMessageVisitor):
             raise ValueError('{} is not an instance of persistent_compute_api_HealthMessageVisitor'.format(visitor.__class__.__name__))
@@ -12322,6 +12337,8 @@ class persistent_compute_api_HealthMessage(ConjureUnionType):
             return visitor._ping(self.ping)
         if self._type == 'pong' and self.pong is not None:
             return visitor._pong(self.pong)
+        if self._type == 'shutdownNotice' and self.shutdown_notice is not None:
+            return visitor._shutdown_notice(self.shutdown_notice)
 
 
 persistent_compute_api_HealthMessage.__name__ = "HealthMessage"
@@ -12339,6 +12356,10 @@ class persistent_compute_api_HealthMessageVisitor:
     def _pong(self, pong: "persistent_compute_api_Pong") -> Any:
         pass
 
+    @abstractmethod
+    def _shutdown_notice(self, shutdown_notice: "persistent_compute_api_ShutdownNotice") -> Any:
+        pass
+
 
 persistent_compute_api_HealthMessageVisitor.__name__ = "HealthMessageVisitor"
 persistent_compute_api_HealthMessageVisitor.__qualname__ = "HealthMessageVisitor"
@@ -12501,6 +12522,28 @@ persistent_compute_api_ServerMessageVisitor.__qualname__ = "ServerMessageVisitor
 persistent_compute_api_ServerMessageVisitor.__module__ = "nominal_api.persistent_compute_api"
 
 
+class persistent_compute_api_ShutdownNotice(ConjureBeanType):
+    """
+    Indicates that the websocket will shut down in the near future. Until it is, SubscriptionUpdates will 
+still be sent to the client. Clients that want to avoid downtime or latency spikes should initiate a new 
+websocket and recreate all their subscriptions there but still keep this websocket open until the new 
+websockets starts sending SubscriptionUpdates.
+    """
+
+    @builtins.classmethod
+    def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
+        return {
+        }
+
+    __slots__: List[str] = []
+
+
+
+persistent_compute_api_ShutdownNotice.__name__ = "ShutdownNotice"
+persistent_compute_api_ShutdownNotice.__qualname__ = "ShutdownNotice"
+persistent_compute_api_ShutdownNotice.__module__ = "nominal_api.persistent_compute_api"
+
+
 class persistent_compute_api_StreamingComputeNodeRequest(ConjureBeanType):
     """
     A templatized version of `ComputeNodeRequest` where the end of the range will track the current time and
@@ -57063,6 +57106,9 @@ The Connection Service is responsible for creating, updating, and retrieving dat
     def add_available_tags(self, auth_header: str, rid: str, tags: Dict[str, List[str]]) -> "scout_datasource_connection_api_Connection":
         """
         Adds available tag key/value pairs to the connection. If a tag name already exists, the values will be merged.
+This is primarily an internal endpoint to update tags for external connections as they are periodically 
+scraped. This endpoint should only be called by clients for Visual crossing connections. Throws if called for
+Nominal connections which have their tags automatically indexed in the underlying Database.
         """
 
         _headers: Dict[str, Any] = {
@@ -57487,7 +57533,7 @@ rather than strictly required.
     @builtins.property
     def available_tag_values(self) -> Optional[Dict[str, List[str]]]:
         """
-        Deprecated, use the getAvailableTagsForConnection endpoint instead
+        Deprecated, use the DataSourceService#getAvailableTagsForConnection endpoint instead
         """
         return self._available_tag_values
 
@@ -57804,7 +57850,7 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
             'connection_details': ConjureFieldDefinition('connectionDetails', scout_datasource_connection_api_ConnectionDetails),
             'metadata': ConjureFieldDefinition('metadata', Dict[str, str]),
             'required_tag_names': ConjureFieldDefinition('requiredTagNames', List[api_TagName]),
-            'available_tag_values': ConjureFieldDefinition('availableTagValues', Dict[api_TagName, List[api_TagValue]]),
+            'available_tag_values': ConjureFieldDefinition('availableTagValues', OptionalTypeWrapper[Dict[api_TagName, List[api_TagValue]]]),
             'scraping': ConjureFieldDefinition('scraping', OptionalTypeWrapper[scout_datasource_connection_api_ScrapingConfig]),
             'should_scrape': ConjureFieldDefinition('shouldScrape', bool),
             'limits': ConjureFieldDefinition('limits', OptionalTypeWrapper[scout_datasource_connection_api_LimitsConfig]),
@@ -57813,7 +57859,7 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
 
     __slots__: List[str] = ['_name', '_description', '_connection_details', '_metadata', '_required_tag_names', '_available_tag_values', '_scraping', '_should_scrape', '_limits', '_workspace']
 
-    def __init__(self, available_tag_values: Dict[str, List[str]], connection_details: "scout_datasource_connection_api_ConnectionDetails", metadata: Dict[str, str], name: str, required_tag_names: List[str], should_scrape: bool, description: Optional[str] = None, limits: Optional["scout_datasource_connection_api_LimitsConfig"] = None, scraping: Optional["scout_datasource_connection_api_ScrapingConfig"] = None, workspace: Optional[str] = None) -> None:
+    def __init__(self, connection_details: "scout_datasource_connection_api_ConnectionDetails", metadata: Dict[str, str], name: str, required_tag_names: List[str], should_scrape: bool, available_tag_values: Optional[Dict[str, List[str]]] = None, description: Optional[str] = None, limits: Optional["scout_datasource_connection_api_LimitsConfig"] = None, scraping: Optional["scout_datasource_connection_api_ScrapingConfig"] = None, workspace: Optional[str] = None) -> None:
         self._name = name
         self._description = description
         self._connection_details = connection_details
@@ -57852,7 +57898,12 @@ class scout_datasource_connection_api_CreateConnection(ConjureBeanType):
         return self._required_tag_names
 
     @builtins.property
-    def available_tag_values(self) -> Dict[str, List[str]]:
+    def available_tag_values(self) -> Optional[Dict[str, List[str]]]:
+        """
+        In most cases, this does not to be set by the user. Throws if populated for Nominal connections, which 
+have their tags automatically indexed in the underlying database. Tags for external connections are 
+periodically scraped. Tags should only be updated  manually for Visual crossing connections.
+        """
         return self._available_tag_values
 
     @builtins.property
@@ -59449,6 +59500,11 @@ class scout_datasource_connection_api_UpdateConnectionRequest(ConjureBeanType):
 
     @builtins.property
     def available_tag_values(self) -> Optional[Dict[str, List[str]]]:
+        """
+        In most cases, this does not to be set by the user. Throws if populated for Nominal connections, which 
+have their tags automatically indexed in the underlying database. Tags for external connections are 
+periodically scraped. Tags should only be updated manually for Visual crossing connections.
+        """
         return self._available_tag_values
 
     @builtins.property

nominal_api/persistent_compute_api/__init__.py

@@ -13,6 +13,7 @@ from .._impl import (
     persistent_compute_api_Pong as Pong,
     persistent_compute_api_ServerMessage as ServerMessage,
     persistent_compute_api_ServerMessageVisitor as ServerMessageVisitor,
+    persistent_compute_api_ShutdownNotice as ShutdownNotice,
     persistent_compute_api_StreamingComputeNodeRequest as StreamingComputeNodeRequest,
     persistent_compute_api_StreamingComputeNodeSubscription as StreamingComputeNodeSubscription,
     persistent_compute_api_SubscriptionCreation as SubscriptionCreation,

{nominal_api-0.628.0.dist-info → nominal_api-0.629.0.dist-info}/METADATA

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

{nominal_api-0.628.0.dist-info → nominal_api-0.629.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-nominal_api/__init__.py,sha256=-DJx7eXFhsHsnuoynSTf8JhPk9tqTR0qumsdfnU7wlQ,1995
-nominal_api/_impl.py,sha256=lDNolI5SxKtRXc8MtLXOz_PVWCDH6S5ZbUDtJfnRnGI,3006835
+nominal_api/__init__.py,sha256=jUMY5gYsmSBUry7_f61vMwCZwxNVRpq6mdcYbaPn1Yw,1995
+nominal_api/_impl.py,sha256=BvZs3xtCZi9_ItPioGLqdF46CzJIPpIIGF1FZMWE3po,3009808
 nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
 nominal_api/api/__init__.py,sha256=1oJPOuAMfV2uClPUW8Ie1nj2Y6j81TDpedcc3yUFTe0,1294
 nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
@@ -17,7 +17,7 @@ nominal_api/datasource_pagination_api/__init__.py,sha256=3GO8TAUavOe6dUEitOhje74
 nominal_api/event/__init__.py,sha256=pim-mIINXhntq9ZtLbCeunLUPhK7sonqI3fCRQalhRA,804
 nominal_api/ingest_api/__init__.py,sha256=jpxmJO0dzcCEIv5iM7xvziQEs1x92XLTm-LmbHxtii4,6953
 nominal_api/ingest_workflow_api/__init__.py,sha256=1oJO78YCmXFkfN5LY7x0gOJwtijrOcXD8Sl0GJCOyrk,1352
-nominal_api/persistent_compute_api/__init__.py,sha256=9X56Ar01aw8PUC7rVVZ2A9Vny0QIXaJPWJtjjCY4IWg,1912
+nominal_api/persistent_compute_api/__init__.py,sha256=OTn2mzP57Bq4MOItkXMockPrDZmHvp6wisuZHcy2K90,1973
 nominal_api/scout/__init__.py,sha256=ip3XK_9jJKAoFiCifUVMTpDMiUE4mWIdGzMDu7LASus,324
 nominal_api/scout_api/__init__.py,sha256=biO4DEygbGcLwM6Dg2VuvMra3A5EW6NBjukbIemXoG8,178
 nominal_api/scout_asset_api/__init__.py,sha256=Ph-KlW-ki0JRejYQZDvbZ2jRzNAttVBux27lcEj7--Q,1910
@@ -73,7 +73,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Q9iZHurmyDsJIFbUg-Eb
 nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
 nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
 nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
-nominal_api-0.628.0.dist-info/METADATA,sha256=aQlqZGTgfC9wSOGBfGFqm2p7nB8b11pnYU98zlMeRlM,199
-nominal_api-0.628.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-nominal_api-0.628.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
-nominal_api-0.628.0.dist-info/RECORD,,
+nominal_api-0.629.0.dist-info/METADATA,sha256=gHiwHkF5uFu_tuaZ2wXcwzjfKv99240XYekQHg8HNcU,199
+nominal_api-0.629.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+nominal_api-0.629.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
+nominal_api-0.629.0.dist-info/RECORD,,