Class PutIndexTemplateRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<Request,Response>
org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<PutIndexTemplateRequest,AcknowledgedResponse,PutIndexTemplateRequestBuilder>
org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateRequestBuilder
public class PutIndexTemplateRequestBuilder extends MasterNodeOperationRequestBuilder<PutIndexTemplateRequest,AcknowledgedResponse,PutIndexTemplateRequestBuilder>
-
Field Summary
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
Constructor Summary
Constructors Constructor Description PutIndexTemplateRequestBuilder(ElasticsearchClient client, PutIndexTemplateAction action)
PutIndexTemplateRequestBuilder(ElasticsearchClient client, PutIndexTemplateAction action, java.lang.String name)
-
Method Summary
Modifier and Type Method Description PutIndexTemplateRequestBuilder
addAlias(Alias alias)
Adds an alias that will be added when the index template gets created.PutIndexTemplateRequestBuilder
addMapping(java.lang.String type, java.lang.Object... source)
A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").PutIndexTemplateRequestBuilder
addMapping(java.lang.String type, java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)
Adds mapping that will be added when the index template gets created.PutIndexTemplateRequestBuilder
addMapping(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> source)
Adds mapping that will be added when the index gets created.PutIndexTemplateRequestBuilder
addMapping(java.lang.String type, org.elasticsearch.common.xcontent.XContentBuilder source)
Adds mapping that will be added when the index template gets created.PutIndexTemplateRequestBuilder
cause(java.lang.String cause)
The cause for this index template creation.PutIndexTemplateRequestBuilder
setAliases(java.lang.String source)
Sets the aliases that will be associated with the index when it gets createdPutIndexTemplateRequestBuilder
setAliases(java.util.Map<java.lang.String,java.lang.Object> source)
Sets the aliases that will be associated with the index when it gets createdPutIndexTemplateRequestBuilder
setAliases(BytesReference source)
Sets the aliases that will be associated with the index when it gets createdPutIndexTemplateRequestBuilder
setAliases(org.elasticsearch.common.xcontent.XContentBuilder source)
Sets the aliases that will be associated with the index when it gets createdPutIndexTemplateRequestBuilder
setCreate(boolean create)
Set totrue
to force only creation, not an update of an index template.PutIndexTemplateRequestBuilder
setOrder(int order)
Sets the order of this template if more than one template matches.PutIndexTemplateRequestBuilder
setPatterns(java.util.List<java.lang.String> indexPatterns)
Sets the match expression that will be used to match on indices created.PutIndexTemplateRequestBuilder
setSettings(java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)
The settings to crete the index template with (either json or yaml format)PutIndexTemplateRequestBuilder
setSettings(java.util.Map<java.lang.String,java.lang.Object> source)
The settings to crete the index template with (either json or yaml format)PutIndexTemplateRequestBuilder
setSettings(Settings settings)
The settings to created the index template with.PutIndexTemplateRequestBuilder
setSettings(Settings.Builder settings)
The settings to created the index template with.PutIndexTemplateRequestBuilder
setSource(byte[] templateSource, int offset, int length, org.elasticsearch.common.xcontent.XContentType xContentType)
The template source definition.PutIndexTemplateRequestBuilder
setSource(byte[] templateSource, org.elasticsearch.common.xcontent.XContentType xContentType)
The template source definition.PutIndexTemplateRequestBuilder
setSource(java.util.Map<java.lang.String,java.lang.Object> templateSource)
The template source definition.PutIndexTemplateRequestBuilder
setSource(BytesReference templateSource, org.elasticsearch.common.xcontent.XContentType xContentType)
The template source definition.PutIndexTemplateRequestBuilder
setSource(org.elasticsearch.common.xcontent.XContentBuilder templateBuilder)
The template source definition.PutIndexTemplateRequestBuilder
setVersion(java.lang.Integer version)
Sets the optional version of this template.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder
setMasterNodeTimeout, setMasterNodeTimeout
Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
execute, execute, get, get, get, request
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
PutIndexTemplateRequestBuilder
-
PutIndexTemplateRequestBuilder
public PutIndexTemplateRequestBuilder(ElasticsearchClient client, PutIndexTemplateAction action, java.lang.String name)
-
-
Method Details
-
setPatterns
Sets the match expression that will be used to match on indices created. -
setOrder
Sets the order of this template if more than one template matches. -
setVersion
Sets the optional version of this template. -
setCreate
Set totrue
to force only creation, not an update of an index template. If it already exists, it will fail with anIllegalArgumentException
. -
setSettings
The settings to created the index template with. -
setSettings
The settings to created the index template with. -
setSettings
public PutIndexTemplateRequestBuilder setSettings(java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)The settings to crete the index template with (either json or yaml format) -
setSettings
public PutIndexTemplateRequestBuilder setSettings(java.util.Map<java.lang.String,java.lang.Object> source)The settings to crete the index template with (either json or yaml format) -
addMapping
public PutIndexTemplateRequestBuilder addMapping(java.lang.String type, java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)Adds mapping that will be added when the index template gets created.- Parameters:
type
- The mapping typesource
- The mapping sourcexContentType
- The type/format of the source
-
addMapping
public PutIndexTemplateRequestBuilder addMapping(java.lang.String type, java.lang.Object... source)A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true"). -
setAliases
public PutIndexTemplateRequestBuilder setAliases(java.util.Map<java.lang.String,java.lang.Object> source)Sets the aliases that will be associated with the index when it gets created -
setAliases
Sets the aliases that will be associated with the index when it gets created -
setAliases
public PutIndexTemplateRequestBuilder setAliases(org.elasticsearch.common.xcontent.XContentBuilder source)Sets the aliases that will be associated with the index when it gets created -
setAliases
Sets the aliases that will be associated with the index when it gets created -
addAlias
Adds an alias that will be added when the index template gets created.- Parameters:
alias
- The alias- Returns:
- the request builder
-
cause
The cause for this index template creation. -
addMapping
public PutIndexTemplateRequestBuilder addMapping(java.lang.String type, org.elasticsearch.common.xcontent.XContentBuilder source)Adds mapping that will be added when the index template gets created.- Parameters:
type
- The mapping typesource
- The mapping source
-
addMapping
public PutIndexTemplateRequestBuilder addMapping(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> source)Adds mapping that will be added when the index gets created.- Parameters:
type
- The mapping typesource
- The mapping source
-
setSource
public PutIndexTemplateRequestBuilder setSource(org.elasticsearch.common.xcontent.XContentBuilder templateBuilder)The template source definition. -
setSource
public PutIndexTemplateRequestBuilder setSource(java.util.Map<java.lang.String,java.lang.Object> templateSource)The template source definition. -
setSource
public PutIndexTemplateRequestBuilder setSource(BytesReference templateSource, org.elasticsearch.common.xcontent.XContentType xContentType)The template source definition. -
setSource
public PutIndexTemplateRequestBuilder setSource(byte[] templateSource, org.elasticsearch.common.xcontent.XContentType xContentType)The template source definition. -
setSource
public PutIndexTemplateRequestBuilder setSource(byte[] templateSource, int offset, int length, org.elasticsearch.common.xcontent.XContentType xContentType)The template source definition.
-