Merge pull request #39 from stefan-brus-frequenz/time_streaming

Add time filters to streaming requests

Author: stefan-brus-frequenz

RELEASE_NOTES.md

@@ -2,15 +2,15 @@
 
 ## Summary
 
-<!-- Here goes a general summary of what this release is about -->
+- Add time filter options to the streaming request, to allow for streaming of historical data.
 
 ## Upgrading
 
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+- The streaming requests now contain optional `TimeFilter` objects for streaming historical data.
 
 ## Bug Fixes
 

proto/frequenz/api/reporting/v1/reporting.proto

@@ -308,6 +308,10 @@ message ReceiveMicrogridComponentsDataStreamRequest {
 
     // Include options specifying additional fields to be included in the response.
     IncludeOptions include_options = 2;
+
+    // Optional time-based filter criteria.
+    // If omitted, data will start streaming from the timestamp that the request was received.
+    TimeFilter time_filter = 3;
   }
 
   // Encapsulates the microgrid ID and the component IDs within that microgrid for which
@@ -499,6 +503,10 @@ message ReceiveAggregatedMicrogridComponentsDataStreamRequest {
     // Optional resampling options like resolution for the data, represented in seconds.
     // If omitted, data will be returned in its original representation.
     ResamplingOptions resampling_options = 1;
+
+    // Optional time-based filter criteria.
+    // If omitted, data will start streaming from the timestamp that the request was received.
+    TimeFilter time_filter = 2;
   }
 
   // List of pairs of metric and corresponding aggregation formula.