Package org.elasticsearch.indices

Class SystemIndexDescriptor.Builder

java.lang.Object

org.elasticsearch.indices.SystemIndexDescriptor.Builder

Enclosing class:

SystemIndexDescriptor

public static class SystemIndexDescriptor.Builder
extends java.lang.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(java.lang.String aliasName)
SystemIndexDescriptor.Builder	setDescription(java.lang.String description)
SystemIndexDescriptor.Builder	setIndexFormat(int indexFormat)
SystemIndexDescriptor.Builder	setIndexPattern(java.lang.String indexPattern)
SystemIndexDescriptor.Builder	setIndexType(java.lang.String indexType)	Deprecated. Index types are going away over the next two major releases.
SystemIndexDescriptor.Builder	setMappings(java.lang.String mappings)
SystemIndexDescriptor.Builder	setMappings(org.elasticsearch.common.xcontent.XContentBuilder mappingsBuilder)
SystemIndexDescriptor.Builder	setMinimumNodeVersion(Version version)
SystemIndexDescriptor.Builder	setOrigin(java.lang.String origin)
SystemIndexDescriptor.Builder	setPrimaryIndex(java.lang.String primaryIndex)
SystemIndexDescriptor.Builder	setSettings(Settings settings)
SystemIndexDescriptor.Builder	setVersionMetaKey(java.lang.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(java.lang.String indexPattern)

setPrimaryIndex

public SystemIndexDescriptor.Builder setPrimaryIndex(java.lang.String primaryIndex)

setDescription

public SystemIndexDescriptor.Builder setDescription(java.lang.String description)

setMappings

public SystemIndexDescriptor.Builder setMappings(org.elasticsearch.common.xcontent.XContentBuilder mappingsBuilder)

setMappings

public SystemIndexDescriptor.Builder setMappings(java.lang.String mappings)

setSettings

public SystemIndexDescriptor.Builder setSettings(Settings settings)

setAliasName

public SystemIndexDescriptor.Builder setAliasName(java.lang.String aliasName)

setIndexFormat

public SystemIndexDescriptor.Builder setIndexFormat(int indexFormat)

setVersionMetaKey

public SystemIndexDescriptor.Builder setVersionMetaKey(java.lang.String versionMetaKey)

setOrigin

public SystemIndexDescriptor.Builder setOrigin(java.lang.String origin)

setIndexType

@Deprecated
public SystemIndexDescriptor.Builder setIndexType(java.lang.String indexType)

Deprecated.

Index types are going away over the next two major releases. New system indices should accept the default, which is MapperService.SINGLE_MAPPING_NAME.

setMinimumNodeVersion

public SystemIndexDescriptor.Builder setMinimumNodeVersion(Version version)

build

public SystemIndexDescriptor build()

Builds a SystemIndexDescriptor using the fields supplied to this builder.

Returns:

a populated descriptor.