Skip to content

Commit

Permalink
Clarify retentionPeriod docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sevein committed Sep 15, 2023
1 parent 59d3bd0 commit 7a21676
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions website/content/en/docs/user-manual/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,11 @@ extraction, the top-level directory will be omitted.

#### `retentionPeriod` (String)

The duration of time for which the transfer should be retained before being
removed. It is mutually exclusive with `completedDir`.
Specifies the duration for which a transfer will be retained before removal.
This attribute is mutually exclusive with completedDir. If undefined, the
transfer is not removed. If set to '0s', the transfer is removed immediately.
This option is undefined by default, meaning the transfer will not be removed
unless specified otherwise.

The string should be constructed as a sequence of decimal numbers, each with
optional fraction and a unit suffix, such as "30m", "24h" or "2h30m".
Expand Down Expand Up @@ -296,8 +299,11 @@ using the `am` pipeline.

#### `retentionPeriod` (String)

The duration of time for which the transfer should be retained before being
removed.
Specifies the duration for which a transfer will be retained before removal.
This attribute is mutually exclusive with completedDir. If undefined, the
transfer is not removed. If set to '0s', the transfer is removed immediately.
This option is undefined by default, meaning the transfer will not be removed
unless specified otherwise.

The string should be constructed as a sequence of decimal numbers, each with
optional fraction and a unit suffix, such as "30m", "24h" or "2h30m".
Expand Down

0 comments on commit 7a21676

Please sign in to comment.