From 03c191f7017383fd7cfab9166399c193bd2f6555 Mon Sep 17 00:00:00 2001 From: 317brian <53799971+317brian@users.noreply.github.com> Date: Wed, 13 Mar 2024 11:52:01 -0700 Subject: [PATCH] docs: clarify description of uri/uriprefix (#16110) * docs: clarify description of uri/uripath * Apply suggestions from code review Co-authored-by: Charles Smith --------- Co-authored-by: Charles Smith --- docs/development/extensions-core/lookups-cached-global.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/development/extensions-core/lookups-cached-global.md b/docs/development/extensions-core/lookups-cached-global.md index 15e1469de4a..5cfcbea01c2 100644 --- a/docs/development/extensions-core/lookups-cached-global.md +++ b/docs/development/extensions-core/lookups-cached-global.md @@ -211,8 +211,8 @@ The remapping values for each globally cached lookup can be specified by a JSON |Property|Description|Required|Default| |--------|-----------|--------|-------| |`pollPeriod`|Period between polling for updates|No|0 (only once)| -|`uri`|URI for the file of interest, specified as a file, hdfs, s3 or gs path|No|Use `uriPrefix`| -|`uriPrefix`|A URI that specifies a directory (or other searchable resource) in which to search for files|No|Use `uri`| +|`uri`|URI for the lookup file. Can be a file, HDFS, S3 or GCS path|Either `uri` or `uriPrefix` must be set|None| +|`uriPrefix`|A URI prefix that specifies a directory or other searchable resource where lookup files are located |Either `uri` or `uriPrefix` must be set|None| |`fileRegex`|Optional regex for matching the file name under `uriPrefix`. Only used if `uriPrefix` is used|No|`".*"`| |`namespaceParseSpec`|How to interpret the data at the URI|Yes|| |`maxHeapPercentage`|The maximum percentage of heap size that the lookup should consume. If the lookup grows beyond this size, warning messages will be logged in the respective service logs.|No|10% of JVM heap size|