Class MetaDataIndexTemplateService
java.lang.Object
org.elasticsearch.cluster.metadata.MetaDataIndexTemplateService
public class MetaDataIndexTemplateService
extends java.lang.Object
Service responsible for submitting index templates updates
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MetaDataIndexTemplateService.PutListener
static class
MetaDataIndexTemplateService.PutRequest
static class
MetaDataIndexTemplateService.PutResponse
static interface
MetaDataIndexTemplateService.RemoveListener
static class
MetaDataIndexTemplateService.RemoveRequest
static class
MetaDataIndexTemplateService.RemoveResponse
-
Constructor Summary
Constructors Constructor Description MetaDataIndexTemplateService(ClusterService clusterService, MetaDataCreateIndexService metaDataCreateIndexService, AliasValidator aliasValidator, IndicesService indicesService, IndexScopedSettings indexScopedSettings, NamedXContentRegistry xContentRegistry)
-
Method Summary
Modifier and Type Method Description static java.util.List<IndexTemplateMetaData>
findTemplates(MetaData metaData, java.lang.String indexName, java.lang.Boolean isHidden)
Finds index templates whose index pattern matched with the given index name.void
putComponentTemplate(java.lang.String cause, boolean create, java.lang.String name, TimeValue masterTimeout, ComponentTemplate template, ActionListener<AcknowledgedResponse> listener)
Add the given component template to the cluster state.void
putTemplate(MetaDataIndexTemplateService.PutRequest request, MetaDataIndexTemplateService.PutListener listener)
void
removeComponentTemplate(java.lang.String name, TimeValue masterTimeout, ActionListener<AcknowledgedResponse> listener)
Remove the given component template from the cluster state.void
removeTemplates(MetaDataIndexTemplateService.RemoveRequest request, MetaDataIndexTemplateService.RemoveListener listener)
-
Constructor Details
-
MetaDataIndexTemplateService
@Inject public MetaDataIndexTemplateService(ClusterService clusterService, MetaDataCreateIndexService metaDataCreateIndexService, AliasValidator aliasValidator, IndicesService indicesService, IndexScopedSettings indexScopedSettings, NamedXContentRegistry xContentRegistry)
-
-
Method Details
-
removeTemplates
public void removeTemplates(MetaDataIndexTemplateService.RemoveRequest request, MetaDataIndexTemplateService.RemoveListener listener) -
putComponentTemplate
public void putComponentTemplate(java.lang.String cause, boolean create, java.lang.String name, TimeValue masterTimeout, ComponentTemplate template, ActionListener<AcknowledgedResponse> listener)Add the given component template to the cluster state. Ifcreate
is true, an exception will be thrown if the component template already exists -
removeComponentTemplate
public void removeComponentTemplate(java.lang.String name, TimeValue masterTimeout, ActionListener<AcknowledgedResponse> listener)Remove the given component template from the cluster state. The component template name supports simple regex wildcards for removing multiple component templates at a time. -
putTemplate
public void putTemplate(MetaDataIndexTemplateService.PutRequest request, MetaDataIndexTemplateService.PutListener listener) -
findTemplates
public static java.util.List<IndexTemplateMetaData> findTemplates(MetaData metaData, java.lang.String indexName, @Nullable java.lang.Boolean isHidden)Finds index templates whose index pattern matched with the given index name. In the case of hidden indices, a template with a match all pattern or global template will not be returned.- Parameters:
metaData
- TheMetaData
containing all of theIndexTemplateMetaData
valuesindexName
- The name of the index that templates are being found forisHidden
- Whether or not the index is known to be hidden. May benull
if the index being hidden has not been explicitly requested. Whennull
if the result of template application results in a hidden index, then global templates will not be returned- Returns:
- a list of templates sorted by
IndexTemplateMetaData.order()
descending.
-