From f8d807b98faf3404d2014d8a4ea07b996fd01152 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Wed, 5 Jun 2024 11:29:46 -0400 Subject: [PATCH] add ttl and data to actors api Signed-off-by: Hannah Hunter --- .../content/en/reference/api/actors_api.md | 23 ++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/api/actors_api.md b/daprdocs/content/en/reference/api/actors_api.md index e2c9920a10d..99a5a3f4a2e 100644 --- a/daprdocs/content/en/reference/api/actors_api.md +++ b/daprdocs/content/en/reference/api/actors_api.md @@ -114,7 +114,7 @@ Parameter | Description #### Examples -> Note, the following example uses the `ttlInSeconds` field, which requires the [`ActorStateTTL` feature enabled]]({{< ref "support-preview-features.md" >}}). +> Note, the following example uses the `ttlInSeconds` field, which requires the [`ActorStateTTL` feature enabled]({{< ref "support-preview-features.md" >}}). ```shell curl -X POST http://localhost:3500/v1.0/actors/stormtrooper/50/state \ @@ -202,6 +202,8 @@ A JSON object with the following fields: |-------|--------------| | `dueTime` | Specifies the time after which the reminder is invoked. Its format should be [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) | `period` | Specifies the period between different invocations. Its format should be [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) or ISO 8601 duration format with optional recurrence. +| `ttl` | Sets time at or interval after which the timer or reminder will be expired and deleted. Its format should be [time.ParseDuration format](https://pkg.go.dev/time#ParseDuration), RFC3339 date format, or ISO 8601 duration format. +| `data` | `period` field supports `time.Duration` format and ISO 8601 format with some limitations. For `period`, only duration format of ISO 8601 duration `Rn/PnYnMnWnDTnHnMnS` is supported. `Rn/` specifies that the reminder will be invoked `n` number of times. @@ -237,6 +239,25 @@ To configure the reminder to fire only once, the period should be set to empty s } ``` +When you specify the repitiion number in both `period` and `ttl`, the timer/reminder will be stopped when either condition is met. The following example has a timer with a `period` of 3 seconds (in ISO 8601 duration format) and a `ttl` of 20 seconds. This timer fires immediately after registration, then every 3 seconds after that for the duration of 20 seconds. + +```json +{ + "period":"PT3S", + "ttl":"20s" +} +``` + +Need description for data. + +```json +{ + "data": "someData", + "dueTime": "1m", + "period": "20s" +} +``` + #### HTTP Response Codes Code | Description