Skip to content

Commit

Permalink
DOCS-2825/DOCS-3117: Document set data retention policy by amount of …
Browse files Browse the repository at this point in the history
…data (#3663)
  • Loading branch information
sguequierre authored Nov 11, 2024
1 parent 3ee344e commit e4e9adf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/services/data/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ The following attributes are available for data capture configuration:
| ------------------ | ------ | --------- | ----------- |
| `capture_frequency_hz` | float | **Required** | Frequency in hertz at which to capture data. For example, to capture a reading every 2 seconds, enter `0.5`. |
| `method` | string | **Required** | Depends on the type of component or service. See [Supported components and services](/services/data/#supported-components-and-services). |
| `retention_policy` | object | Optional | Option to configure how long data collected by this component should remain stored in the Viam Cloud. You must set this in JSON mode. See the JSON example for a camera component. Options: `"days": <int>`. Days are in UTC time. Setting a retention policy of 1 day means that data stored now will be deleted the following day **in UTC time**. |
| `retention_policy` | object | Optional | Option to configure how long data collected by this component or service should remain stored in the Viam Cloud. You must set this in JSON mode. See the JSON example for a camera component. <br> **Options:** `"days": <int>`, `"binary_limit_gb": <int>`, `"tabular_limit_gb": <int>`. <br> Days are in UTC time. Setting a retention policy of 1 day means that data stored now will be deleted the following day **in UTC time**. You can set either or both of the size limit options and size is in gigabytes. |
| `additional_params` | depends | depends | Varies based on the method. For example, `ReadImage` requires a MIME type. |

### Supported components and services
Expand Down

0 comments on commit e4e9adf

Please sign in to comment.