Comments (4)
I'd remove the "Maybe it would be also worth clarifying that " ;)
from frequenz-api-dispatch.
Oh, sorry I've improved the above.
from frequenz-api-dispatch.
Maybe it would be also worth clarifying that this is a duration within one run if it is a recurring dispatch. It is not related to the recurrence itself.
from frequenz-api-dispatch.
@leandro-lucarella-frequenz how about?
message Dispatch {
// ...
- // Duration in seconds
+ // Duration of the dispatch in seconds.
+ //
+ // The duration specifies how long each occurrence of the dispatch lasts during
+ // a single run, applies only to the individual instance and not the overall cycle of
+ // recurring dispatches. This setting is independent of the recurrence pattern,
+ // which is governed by separate recurrence settings.
+ //
+ // !!! note
+ // This field manages how long each occurrence of the dispatch lasts:
+ // - `null` value indicates an infinite duration, meaning each dispatch occurrence
+ //. continues indefinitely.
+ // - A value of `0` indicates a one-time execution for that particular occurrence,
+ // which does not repeat or persist beyond its initial run.
+ // - Positive values specify the duration in seconds for each dispatch occurrence
+ // should be active.
+ //
+ // Example of how to set duration
+ // duration_seconds: { value: 3600 } // Duration of 1 hour
+ // duration_seconds: null // Infinite duration
+ // duration_seconds: { value: 0 } // One-time execution
+ //
- // uint32 duration = 7;
+ // optional uint32 duration_seconds = 7;
}
The duration
parameter is renamed to duration_seconds
so its more distinct from the recurrence pattern settings, ensuring that there's less confusion between the duration of individual runs and the overall scheduling pattern. Moreover, at the top it explicitly states that the duration_seconds
applies to each individual occurrence of the dispatch.
from frequenz-api-dispatch.
Related Issues (20)
- Adjust documentation according to Dart style guide & mkdocs admonitions
- Use FieldMasks and fix `optional` keyword usage
- Return dispatch on `CreateMicrogridDispatch` and `UpdateMicrogridDispatch` request HOT 1
- Support Pagination on `ListMicrogridDispatches`
- Streaming rpc method HOT 1
- Restructure RPC methods HOT 2
- Renames `dispatches` to `dispatch_list` HOT 4
- Improve UTC timestamp documentation
- Add example to documentation of "payload" field
- Document error response behavior HOT 2
- Extend `ListMicrogridDispatches` to support receiving dispatches by last modification time HOT 5
- "Yearly" frequency missing from recurrence rule HOT 1
- Do not allow updating dispatch `type`
- Extend the dispatch API to allow filtering of reoccurring and non-reoccurring dispatches by their end time HOT 1
- Improve `payload` documentation
- Improve documentation on Modifying Recurrence HOT 1
- Extend `DispatchListRequest` and `DispatchListResponse` to support ordering and pagination. HOT 1
- Restructure and Cleanup of `DispatchCreateRequest` and more HOT 3
- Add Dispatch State HOT 10
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from frequenz-api-dispatch.