Module org.elasticsearch.server

Package org.elasticsearch.internal

Interface CompletionsPostingsFormatExtension

public interface CompletionsPostingsFormatExtension

Allows plugging-in the Completions Postings Format.

Method Summary

Modifier and Type	Method	Description
String	getFormatName()	Returns the name of the CompletionPostingsFormat that Elasticsearch should use.

Method Details

getFormatName

String getFormatName()

Returns the name of the CompletionPostingsFormat that Elasticsearch should use. Should return null if the extension is not enabled.

Note that the name must match a codec that is available on all nodes in the cluster, otherwise IndexCorruptionExceptions will occur. A feature can be used to protect against this scenario, or alternatively, the codec code can be rolled out prior to its usage by this extension.