Package org.opensearch.client.opensearch.indices

Class PutTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.PutTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutTemplateRequest>

Enclosing class:

PutTemplateRequest

public static class PutTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<PutTemplateRequest>

Builder for PutTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutTemplateRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the index.
PutTemplateRequest.Builder	aliases(java.lang.String key, Alias value)	Aliases for the index.
PutTemplateRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	Aliases for the index.
PutTemplateRequest	build()	Builds a PutTemplateRequest.
PutTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
PutTemplateRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
PutTemplateRequest.Builder	create(java.lang.Boolean value)	If true, this request cannot replace or update existing index templates.
PutTemplateRequest.Builder	flatSettings(java.lang.Boolean value)	API name: flat_settings
PutTemplateRequest.Builder	indexPatterns(java.lang.String value, java.lang.String... values)	Array of wildcard expressions used to match the names of indices during creation.
PutTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> list)	Array of wildcard expressions used to match the names of indices during creation.
PutTemplateRequest.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Mapping for fields in the index.
PutTemplateRequest.Builder	mappings(TypeMapping value)	Mapping for fields in the index.
PutTemplateRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
PutTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
PutTemplateRequest.Builder	name(java.lang.String value)	Required - The name of the template
PutTemplateRequest.Builder	order(java.lang.Integer value)	Order in which Elasticsearch applies this template if index matches multiple templates.
PutTemplateRequest.Builder	settings(java.lang.String key, JsonData value)	Configuration options for the index.
PutTemplateRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> map)	Configuration options for the index.
PutTemplateRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: timeout
PutTemplateRequest.Builder	timeout(Time value)	API name: timeout
PutTemplateRequest.Builder	version(java.lang.Long value)	Version number used to manage index templates externally.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

aliases

public final PutTemplateRequest.Builder aliases(java.util.Map<java.lang.String,Alias> map)

Aliases for the index.

API name: aliases

Adds all entries of map to aliases.

aliases

public final PutTemplateRequest.Builder aliases(java.lang.String key,
                                                Alias value)

Aliases for the index.

API name: aliases

Adds an entry to aliases.

aliases

public final PutTemplateRequest.Builder aliases(java.lang.String key,
                                                java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Aliases for the index.

API name: aliases

Adds an entry to aliases using a builder lambda.

create

public final PutTemplateRequest.Builder create(@Nullable
                                               java.lang.Boolean value)

If true, this request cannot replace or update existing index templates.

API name: create

flatSettings

public final PutTemplateRequest.Builder flatSettings(@Nullable
                                                     java.lang.Boolean value)

API name: flat_settings

indexPatterns

public final PutTemplateRequest.Builder indexPatterns(java.util.List<java.lang.String> list)

Array of wildcard expressions used to match the names of indices during creation.

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

public final PutTemplateRequest.Builder indexPatterns(java.lang.String value,
                                                      java.lang.String... values)

Array of wildcard expressions used to match the names of indices during creation.

API name: index_patterns

Adds one or more values to indexPatterns.

mappings

public final PutTemplateRequest.Builder mappings(@Nullable
                                                 TypeMapping value)

Mapping for fields in the index.

API name: mappings

mappings

public final PutTemplateRequest.Builder mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

Mapping for fields in the index.

API name: mappings

masterTimeout

@Deprecated
public final PutTemplateRequest.Builder masterTimeout(@Nullable
                                                      Time value)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
public final PutTemplateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

public final PutTemplateRequest.Builder clusterManagerTimeout(@Nullable
                                                              Time value)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

public final PutTemplateRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

name

public final PutTemplateRequest.Builder name(java.lang.String value)

Required - The name of the template

API name: name

order

public final PutTemplateRequest.Builder order(@Nullable
                                              java.lang.Integer value)

Order in which Elasticsearch applies this template if index matches multiple templates.

Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values.

API name: order

settings

public final PutTemplateRequest.Builder settings(java.util.Map<java.lang.String,JsonData> map)

Configuration options for the index.

API name: settings

Adds all entries of map to settings.

settings

public final PutTemplateRequest.Builder settings(java.lang.String key,
                                                 JsonData value)

Configuration options for the index.

API name: settings

Adds an entry to settings.

timeout

public final PutTemplateRequest.Builder timeout(@Nullable
                                                Time value)

API name: timeout

timeout

public final PutTemplateRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: timeout

version

public final PutTemplateRequest.Builder version(@Nullable
                                                java.lang.Long value)

Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

API name: version

build

public PutTemplateRequest build()

Builds a PutTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutTemplateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.