Package com.yahoo.vespa.model
Interface ConfigProducer
- All Superinterfaces:
com.yahoo.config.ConfigInstance.Producer
- All Known Subinterfaces:
ConfigProducerRoot
,Service
- All Known Implementing Classes:
AbstractConfigProducerRoot
,AbstractService
,AccessLogComponent
,Admin
,AnyConfigProducer
,ApplicationConfigProducerRoot
,ApplicationContainer
,ApplicationContainerCluster
,BertEmbedder
,BlockFeedGlobalEndpointsFilter
,Chain
,ChainedComponent
,Chains
,Client
,CloudSecretStore
,CloudSslProvider
,ClusterControllerCluster
,ClusterControllerComponent
,ClusterControllerConfig
,ClusterControllerConfigurer
,ClusterControllerContainer
,ClusterControllerContainerCluster
,ColBertEmbedder
,Component
,ComponentGroup
,ConfigProducerGroup
,ConfigProxy
,ConfigSentinel
,Configserver
,ConfigserverCluster
,ConfiguredFilebasedSslProvider
,ConnectionLogComponent
,ConnectorFactory
,Container
,ContainerCluster
,ContainerThreadpool
,ContentCluster
,ContentNode
,ContentSearchCluster
,CustomSslProvider
,DataplaneProxy
,DefaultSslProvider
,DispatcherComponent
,Distributor
,DistributorCluster
,DocprocChain
,DocprocChains
,DocumentDatabase
,DocumentProcessor
,DummyPersistence
,FederationSearcher
,FileStatusHandlerComponent
,Filter
,FilterChains
,FilterConfigProvider
,GenericProvider
,GenericTarget
,Handler
,Handler.DefaultHandlerThreadpool
,Host
,HostedSslConnectorFactory
,HostSystem
,Http
,HttpFilterChain
,HuggingFaceEmbedder
,HuggingFaceTokenizer
,IdentityProvider
,IndexedSearchCluster
,IndexedSearchCluster.MultipleDocumentDatabasesConfigProducer
,IndexingDocprocChain
,IndexingProcessor
,JettyHttpServer
,JettyHttpServer.FilterBindingsProviderComponent
,LocalProvider
,Logd
,LogForwarder
,Logserver
,LogserverContainer
,LogserverContainerCluster
,MbusClient
,MetricsProxyContainer
,MetricsProxyContainerCluster
,MockRoot
,ModelConfigProvider
,PersistenceEngine
,ProcessingChain
,ProcessingChains
,ProcessingHandler
,Processor
,ProtonProvider
,Provider
,RankProfilesEvaluatorComponent
,SearchChain
,SearchChains
,SearchCluster
,Searcher
,SearchNode
,SimpleComponent
,SimpleConfigProducer
,Slobrok
,Source
,SpladeEmbedder
,SslProvider
,StorageCluster
,StorageNode
,StreamingSearchCluster
,TransactionLogServer
,TreeConfigProducer
,Tuning
,VespaModel
public interface ConfigProducer
extends com.yahoo.config.ConfigInstance.Producer
Interface that should be implemented by all config producing modules
in the vespa model.
- Author:
- gjoranv
-
Method Summary
Modifier and TypeMethodDescriptionboolean
addUserConfig
(com.yahoo.config.ConfigInstance.Builder builder) Adds user config override from this ConfigProducer to the existing builderboolean
cascadeConfig
(com.yahoo.config.ConfigInstance.Builder builder) Build config from this and all parent ConfigProducers, such that the root node's config will be added first, and this ConfigProducer's config last in the returned builder.default void
dump
(PrintStream out) Dump the tree of config producers to the specified stream.default Map<String,
? extends ConfigProducer> Returns this ConfigProducer's children (only 1st level)Returns the configId of this ConfigProducer.Returns a List of all Services that are descendants to this ConfigProducerReturns the user configs of thisReturns the one and only HostSystem of the root nodevoid
validate()
check constraints depending on the state of the vespamodel graph.
-
Method Details
-
getConfigId
String getConfigId()Returns the configId of this ConfigProducer. -
hostSystem
HostSystem hostSystem()Returns the one and only HostSystem of the root node -
getUserConfigs
UserConfigRepo getUserConfigs()Returns the user configs of this -
getChildren
Returns this ConfigProducer's children (only 1st level) -
getDescendantServices
Returns a List of all Services that are descendants to this ConfigProducer -
dump
Dump the tree of config producers to the specified stream.- Parameters:
out
- The stream to print to, e.g. System.out
-
cascadeConfig
boolean cascadeConfig(com.yahoo.config.ConfigInstance.Builder builder) Build config from this and all parent ConfigProducers, such that the root node's config will be added first, and this ConfigProducer's config last in the returned builder.- Parameters:
builder
- The builder implemented by the concrete ConfigInstance class- Returns:
- true if a model config producer was found, so config was applied
-
addUserConfig
boolean addUserConfig(com.yahoo.config.ConfigInstance.Builder builder) Adds user config override from this ConfigProducer to the existing builder- Parameters:
builder
- The ConfigBuilder to add user config overrides.- Returns:
- true if overrides were added, false if not.
-
validate
check constraints depending on the state of the vespamodel graph. When overriding, you must invoke super.- Throws:
Exception
-