Module org.elasticsearch.server
Package org.elasticsearch.indices
Class SystemIndexDescriptor.Builder
java.lang.Object
org.elasticsearch.indices.SystemIndexDescriptor.Builder
- Enclosing class:
- SystemIndexDescriptor
Provides a fluent API for building a
SystemIndexDescriptor
. Validation still happens in that class.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aSystemIndexDescriptor
using the fields supplied to this builder.setAliasName
(String aliasName) setAllowedElasticProductOrigins
(List<String> allowedElasticProductOrigins) setDescription
(String description) setIndexFormat
(int indexFormat) setIndexPattern
(String indexPattern) setMappings
(String mappings) setMappings
(XContentBuilder mappingsBuilder) setMinimumNodeVersion
(Version version) Sometimes a system operation will need to dispatch sub-actions.setPrimaryIndex
(String primaryIndex) setPriorSystemIndexDescriptors
(List<SystemIndexDescriptor> priorSystemIndexDescriptors) setSettings
(Settings settings) setThreadPools
(ExecutorNames threadPoolExecutorNames) setVersionMetaKey
(String versionMetaKey)
-
Method Details
-
setIndexPattern
-
setPrimaryIndex
-
setDescription
-
setMappings
-
setMappings
-
setSettings
-
setAliasName
-
setIndexFormat
-
setVersionMetaKey
-
setOrigin
Sometimes a system operation will need to dispatch sub-actions. A product origin string will tell the system which component generated the sub-action. Internal system indices must not provide an origin, since they are supposed to reject access from outside the system. External system indices, on the other hand, must provide an origin. SeeOriginSettingClient
for more information.- Parameters:
origin
- the client origin to use when creating this index.- Returns:
- a
SystemIndexDescriptor.Builder
object
-
setMinimumNodeVersion
-
setType
-
setAllowedElasticProductOrigins
public SystemIndexDescriptor.Builder setAllowedElasticProductOrigins(List<String> allowedElasticProductOrigins) -
setPriorSystemIndexDescriptors
public SystemIndexDescriptor.Builder setPriorSystemIndexDescriptors(List<SystemIndexDescriptor> priorSystemIndexDescriptors) -
setThreadPools
-
setNetNew
-
setAllowsTemplates
-
build
Builds aSystemIndexDescriptor
using the fields supplied to this builder.- Returns:
- a populated descriptor.
-