Interface BuildCacheServiceFactory.Describer
- Enclosing interface:
BuildCacheServiceFactory<T extends BuildCache>
The description is for human consumption. It may be logged and displayed by tooling.
- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionSets a configuration param of the cache being used.Sets the description of the type of cache being used.
-
Method Details
-
type
Sets the description of the type of cache being used.The value should not include particulars about the cache; only a human friendly description of the kind of cache. For example, instead of
"HTTP @ https://some/cache"it should be just"HTTP". Particular configuration should be set viaconfig(String, String).BuildCacheServiceFactoryimplementations should always return the same value for the same cache "type". All implementations should call this method.Values should be lowercase, except where using an acronym (e.g. HTTP).
Subsequent calls to this method replace the previously set value.
-
config
Sets a configuration param of the cache being used.e.g.
config("location", "https://some/cache").Values may be logged. Secrets (e.g. passwords) should not be declared with this method.
Implementations should describe their config where possible.
Subsequent calls to this method with the same
nameargument will replace the previously suppliedvalueargument.Subsequent calls to this method with different
namearguments will append values.
-