[state store ttl] Added metadata.ttlInSeconds (#2583)

* initial change

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove from table

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update title

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
Hannah Hunter 2022-07-05 20:09:31 -05:00 committed by GitHub
parent dd445be31f
commit f0d4758be5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 3 deletions

View File

@ -1,9 +1,9 @@
---
type: docs
title: "How-To: Set state Time-to-Live (TTL)"
linkTitle: "How-To: Set state TTL"
title: "State Time-to-Live (TTL)"
linkTitle: "State TTL"
weight: 500
description: "Manage state with time-to-live."
description: "Manage state with TTL."
---
## Introduction

View File

@ -82,6 +82,16 @@ Field | Description
> **ETag format:** Dapr runtime treats ETags as opaque strings. The exact ETag format is defined by the corresponding data store.
#### Metadata
Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.`, as shown below.
Parameter | Description
--------- | -----------
`metadata.ttlInSeconds` | The number of seconds for the message to expire, as [described here]({{< ref state-store-ttl.md >}})
> **TTL:** Only certain state stores support the TTL option, according the [supported state stores]({{< ref supported-state-stores.md >}}).
### HTTP Response
#### Response Codes