Skip to main content

Module usecases

Module usecases 

Source
Expand description

Configuration and validation for use case properties.

Use cases are user-defined strings that namespace objects (e.g. attachments, debug-files). This module provides a central place to configure properties of use cases, such as which expiration policies are permitted and any duration caps.

Unconfigured use cases receive the default configuration: all expiration policies are allowed with no duration caps.

§YAML Configuration

usecases:
  attachments:
    expiration:
      manual:
        allowed: false
      tti:
        allowed: false
      max: "90d"
  debug-files:
    expiration:
      max: "90d"

Structs§

ExpirationConfig
Controls which expiration policies are allowed and their duration constraints.
PolicyConfig
Configuration for an expiration policy.
UseCaseConfig
Configuration for a single use case.
UseCases
Configuration for all use case properties.

Enums§

UseCaseError
Errors produced when metadata violates a use case’s configuration.