Module org.elasticsearch.server

Package org.elasticsearch.indices

Class SystemIndexDescriptor.Builder

java.lang.Object

org.elasticsearch.indices.SystemIndexDescriptor.Builder

Enclosing class:

SystemIndexDescriptor

public static class SystemIndexDescriptor.Builder
extends Object

Provides a fluent API for building a SystemIndexDescriptor. Validation still happens in that class.

Method Summary

Modifier and Type	Method	Description
SystemIndexDescriptor	build()	Builds a SystemIndexDescriptor using the fields supplied to this builder.
SystemIndexDescriptor.Builder	setAliasName(String aliasName)
SystemIndexDescriptor.Builder	setAllowedElasticProductOrigins(List<String> allowedElasticProductOrigins)
SystemIndexDescriptor.Builder	setAllowsTemplates()
SystemIndexDescriptor.Builder	setDescription(String description)
SystemIndexDescriptor.Builder	setIndexFormat(int indexFormat)
SystemIndexDescriptor.Builder	setIndexPattern(String indexPattern)
SystemIndexDescriptor.Builder	setMappings(String mappings)
SystemIndexDescriptor.Builder	setMappings(XContentBuilder mappingsBuilder)
SystemIndexDescriptor.Builder	setMinimumNodeVersion(Version version)
SystemIndexDescriptor.Builder	setNetNew()
SystemIndexDescriptor.Builder	setOrigin(String origin)	Sometimes a system operation will need to dispatch sub-actions.
SystemIndexDescriptor.Builder	setPrimaryIndex(String primaryIndex)
SystemIndexDescriptor.Builder	setPriorSystemIndexDescriptors(List<SystemIndexDescriptor> priorSystemIndexDescriptors)
SystemIndexDescriptor.Builder	setSettings(Settings settings)
SystemIndexDescriptor.Builder	setThreadPools(ExecutorNames threadPoolExecutorNames)
SystemIndexDescriptor.Builder	setType(SystemIndexDescriptor.Type type)
SystemIndexDescriptor.Builder	setVersionMetaKey(String versionMetaKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setIndexPattern

public SystemIndexDescriptor.Builder setIndexPattern(String indexPattern)

setPrimaryIndex

public SystemIndexDescriptor.Builder setPrimaryIndex(String primaryIndex)

setDescription

public SystemIndexDescriptor.Builder setDescription(String description)

setMappings

public SystemIndexDescriptor.Builder setMappings(XContentBuilder mappingsBuilder)

setMappings

public SystemIndexDescriptor.Builder setMappings(String mappings)

setSettings

public SystemIndexDescriptor.Builder setSettings(Settings settings)

setAliasName

public SystemIndexDescriptor.Builder setAliasName(String aliasName)

setIndexFormat

public SystemIndexDescriptor.Builder setIndexFormat(int indexFormat)

setVersionMetaKey

public SystemIndexDescriptor.Builder setVersionMetaKey(String versionMetaKey)

setOrigin

public SystemIndexDescriptor.Builder setOrigin(String origin)

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. See OriginSettingClient for more information.

Parameters:

origin - the client origin to use when creating this index.

Returns:

a SystemIndexDescriptor.Builder object

setMinimumNodeVersion

public SystemIndexDescriptor.Builder setMinimumNodeVersion(Version version)

setType

public SystemIndexDescriptor.Builder setType(SystemIndexDescriptor.Type type)

setAllowedElasticProductOrigins

public SystemIndexDescriptor.Builder setAllowedElasticProductOrigins(List<String> allowedElasticProductOrigins)

setPriorSystemIndexDescriptors

public SystemIndexDescriptor.Builder setPriorSystemIndexDescriptors(List<SystemIndexDescriptor> priorSystemIndexDescriptors)

setThreadPools

public SystemIndexDescriptor.Builder setThreadPools(ExecutorNames threadPoolExecutorNames)

setNetNew

public SystemIndexDescriptor.Builder setNetNew()

setAllowsTemplates

public SystemIndexDescriptor.Builder setAllowsTemplates()

build

public SystemIndexDescriptor build()

Builds a SystemIndexDescriptor using the fields supplied to this builder.

Returns:

a populated descriptor.