list Config

Index

Params

Field Type Description
providerUrl string Where to find the list to check against. This may be ommited for a completely local list.
refreshInterval Duration Determines how often the provider is polled for an updated list
ttl Duration Indicates how long to keep a list before discarding it. Typically, the TTL value should be set to noticeably longer (> 2x) than the refresh interval to ensure continued operation in the face of transient server outages.
cachingInterval Duration Indicates the amount of time a caller of this adapter can cache an answer before it should ask the adapter again.
cachingUseCount int32 Indicates the number of times a caller of this adapter can use a cached answer before it should ask the adapter again.
overrides[] repeated string List entries that are consulted first, before the list from the server
entryType ListEntryType Determines the kind of list entry and overrides.
blacklist bool Whether the list operates as a blacklist or a whitelist.

ListEntryType

Value Description
STRINGS List entries are treated as plain strings.
CASE_INSENSITIVE_STRINGS List entries are treated as case-insensitive strings.
IP_ADDRESSES List entries are treated as IP addresses and ranges.