Package org.opensearch.action.admin.indices.template.put

Class PutIndexTemplateRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<PutIndexTemplateRequest,AcknowledgedResponse>

org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder<PutIndexTemplateRequest,AcknowledgedResponse,PutIndexTemplateRequestBuilder>

org.opensearch.action.admin.indices.template.put.PutIndexTemplateRequestBuilder

@PublicApi(since="1.0.0")
public class PutIndexTemplateRequestBuilder
extends ClusterManagerNodeOperationRequestBuilder<PutIndexTemplateRequest,AcknowledgedResponse,PutIndexTemplateRequestBuilder>

A request builder for putting an index template into the cluster state

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
PutIndexTemplateRequestBuilder(OpenSearchClient client, PutIndexTemplateAction action)
PutIndexTemplateRequestBuilder(OpenSearchClient client, PutIndexTemplateAction action, 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	cause(String cause)	The cause for this index template creation.
PutIndexTemplateRequestBuilder	setAliases(String source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequestBuilder	setAliases(Map<String,Object> source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequestBuilder	setAliases(org.opensearch.core.common.bytes.BytesReference source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequestBuilder	setAliases(org.opensearch.core.xcontent.XContentBuilder source)	Sets the aliases that will be associated with the index when it gets created
PutIndexTemplateRequestBuilder	setCreate(boolean create)	Set to true to force only creation, not an update of an index template.
PutIndexTemplateRequestBuilder	setMapping(String... source)	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
PutIndexTemplateRequestBuilder	setMapping(String source, org.opensearch.core.xcontent.MediaType mediaType)	Adds mapping that will be added when the index template gets created.
PutIndexTemplateRequestBuilder	setMapping(org.opensearch.core.xcontent.XContentBuilder source)	Adds mapping that will be added when the index template gets created.
PutIndexTemplateRequestBuilder	setOrder(int order)	Sets the order of this template if more than one template matches.
PutIndexTemplateRequestBuilder	setPatterns(List<String> indexPatterns)	Sets the match expression that will be used to match on indices created.
PutIndexTemplateRequestBuilder	setSettings(String source, org.opensearch.core.xcontent.MediaType mediaType)	The settings to crete the index template with (either json or yaml format)
PutIndexTemplateRequestBuilder	setSettings(Map<String,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.opensearch.common.xcontent.XContentType xContentType)	The template source definition.
PutIndexTemplateRequestBuilder	setSource(byte[] templateSource, org.opensearch.core.xcontent.MediaType mediaType)	The template source definition.
PutIndexTemplateRequestBuilder	setSource(Map<String,Object> templateSource)	The template source definition.
PutIndexTemplateRequestBuilder	setSource(org.opensearch.core.common.bytes.BytesReference templateSource, org.opensearch.core.xcontent.MediaType mediaType)	The template source definition.
PutIndexTemplateRequestBuilder	setSource(org.opensearch.core.xcontent.XContentBuilder templateBuilder)	The template source definition.
PutIndexTemplateRequestBuilder	setVersion(Integer version)	Sets the optional version of this template.

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder

setClusterManagerNodeTimeout, setClusterManagerNodeTimeout, setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.opensearch.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

public PutIndexTemplateRequestBuilder(OpenSearchClient client,
 PutIndexTemplateAction action)

PutIndexTemplateRequestBuilder

public PutIndexTemplateRequestBuilder(OpenSearchClient client,
 PutIndexTemplateAction action,
 String name)

Method Details

setPatterns

public PutIndexTemplateRequestBuilder setPatterns(List<String> indexPatterns)

Sets the match expression that will be used to match on indices created.

setOrder

public PutIndexTemplateRequestBuilder setOrder(int order)

Sets the order of this template if more than one template matches.

setVersion

public PutIndexTemplateRequestBuilder setVersion(Integer version)

Sets the optional version of this template.

setCreate

public PutIndexTemplateRequestBuilder setCreate(boolean create)

Set to true to force only creation, not an update of an index template. If it already exists, it will fail with an IllegalArgumentException.

setSettings

public PutIndexTemplateRequestBuilder setSettings(Settings settings)

The settings to created the index template with.

setSettings

public PutIndexTemplateRequestBuilder setSettings(Settings.Builder settings)

The settings to created the index template with.

setSettings

public PutIndexTemplateRequestBuilder setSettings(String source,
 org.opensearch.core.xcontent.MediaType mediaType)

The settings to crete the index template with (either json or yaml format)

setSettings

public PutIndexTemplateRequestBuilder setSettings(Map<String,Object> source)

The settings to crete the index template with (either json or yaml format)

setMapping

public PutIndexTemplateRequestBuilder setMapping(String source,
 org.opensearch.core.xcontent.MediaType mediaType)

Adds mapping that will be added when the index template gets created.

Parameters:

source - The mapping source

mediaType - The type/format of the source

setMapping

public PutIndexTemplateRequestBuilder setMapping(String... source)

A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").

setAliases

public PutIndexTemplateRequestBuilder setAliases(Map<String,Object> source)

Sets the aliases that will be associated with the index when it gets created

setAliases

public PutIndexTemplateRequestBuilder setAliases(String source)

Sets the aliases that will be associated with the index when it gets created

setAliases

public PutIndexTemplateRequestBuilder setAliases(org.opensearch.core.xcontent.XContentBuilder source)

Sets the aliases that will be associated with the index when it gets created

setAliases

public PutIndexTemplateRequestBuilder setAliases(org.opensearch.core.common.bytes.BytesReference source)

Sets the aliases that will be associated with the index when it gets created

addAlias

public PutIndexTemplateRequestBuilder addAlias(Alias alias)

Adds an alias that will be added when the index template gets created.

Parameters:

alias - The alias

Returns:

the request builder

cause

public PutIndexTemplateRequestBuilder cause(String cause)

The cause for this index template creation.

setMapping

public PutIndexTemplateRequestBuilder setMapping(org.opensearch.core.xcontent.XContentBuilder source)

Adds mapping that will be added when the index template gets created.

Parameters:

source - The mapping source

setSource

public PutIndexTemplateRequestBuilder setSource(org.opensearch.core.xcontent.XContentBuilder templateBuilder)

The template source definition.

setSource

public PutIndexTemplateRequestBuilder setSource(Map<String,Object> templateSource)

The template source definition.

setSource

public PutIndexTemplateRequestBuilder setSource(org.opensearch.core.common.bytes.BytesReference templateSource,
 org.opensearch.core.xcontent.MediaType mediaType)

The template source definition.

setSource

public PutIndexTemplateRequestBuilder setSource(byte[] templateSource,
 org.opensearch.core.xcontent.MediaType mediaType)

The template source definition.

setSource

public PutIndexTemplateRequestBuilder setSource(byte[] templateSource,
 int offset,
 int length,
 org.opensearch.common.xcontent.XContentType xContentType)

The template source definition.