CollectionExpiryPolicy | Andi Skill Builder API Documentation

Hierarchy

CollectionExpiryPolicy

Index

Properties

expireMode

The mode that determines how the expiration of collection data is to be handled.

Expiration is handled on a per collection item basis. For example, the expiration policy for a dictionary would dictate when to expire individual key-value entries.

Never: The collection data will never expire.
FixedDurationAfterCreate: The TTL is a fixed duration after a collection item is created.
FixedDurationAfterLastUpdate: The TTL is a fixed duration that resets with every update to the collection item.

Optional ttl

ttl: number

The time-to-live (TTL) value in seconds. This determines how long the collection items should be retained before it becomes eligible for automatic deletion due to expiration. This value is only applicable if expireMode is set to CollectionExpirationMode.FixedDurationAfterCreate or CollectionExpirationMode.FixedDurationAfterLastUpdate. Max allowed value is one year in seconds, 31_536_000;