omnata-plugin-runtime 0.4.2a97__tar.gz → 0.4.3a98__tar.gz

{omnata_plugin_runtime-0.4.2a97 → omnata_plugin_runtime-0.4.3a98}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.4.2a97
+Version: 0.4.3a98
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.4.2a97 → omnata_plugin_runtime-0.4.3a98}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.4.2-a97"
+version = "0.4.3-a98"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.4.2a97 → omnata_plugin_runtime-0.4.3a98}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -1126,6 +1126,16 @@ class InboundSyncRequest(SyncRequest):
         Sets the record count for a stream, used to provide progress updates.
         """
         self._stream_record_counts[stream_name] = count
+    
+    def set_stream_total_records_estimate(self, stream_name: str, count: int):
+        """
+        Sets the total record count for a stream, used to provide progress updates.
+        This should be a best estimate of the number of changes which will be fetched from the source.
+        In other words, as results are enqueued they should build toward reaching this number as the sync progresses.
+        This does not have to be exact, it's just to give the user some feedback while the sync is running.
+        Totals will always be replaced by the actual count when the stream is completed.
+        """
+        self._total_records_estimate[stream_name] = count
 
     def _enqueue_state(self, stream_name: str, new_state: Any):
         """