Package co.elastic.clients.elasticsearch.indices

Class PutTemplateRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.indices.PutTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutTemplateRequest>

Enclosing class:

PutTemplateRequest

public static class PutTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<PutTemplateRequest>

Builder for PutTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutTemplateRequest.Builder	addIndexPatterns(java.lang.String value)	Add a value to indexPatterns(List), creating the list if needed.
PutTemplateRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Set aliases(Map) to a singleton map.
PutTemplateRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> value)	Aliases for the index.
PutTemplateRequest	build()	Builds a PutTemplateRequest.
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	includeTypeName(java.lang.Boolean value)	Whether a type should be returned in the body of the mappings.
PutTemplateRequest.Builder	indexPatterns(java.lang.String... value)	Array of wildcard expressions used to match the names of indices during creation.
PutTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> value)	Array of wildcard expressions used to match the names of indices during creation.
PutTemplateRequest.Builder	mappings(TypeMapping value)	Mapping for fields in the index.
PutTemplateRequest.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Mapping for fields in the index.
PutTemplateRequest.Builder	masterTimeout(java.lang.String value)	Period to wait for a connection to the master node.
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	putAliases(java.lang.String key, Alias value)	Add a key/value to aliases(Map), creating the map if needed.
PutTemplateRequest.Builder	putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Add a key/value to aliases(Map), creating the map if needed.
PutTemplateRequest.Builder	putSettings(java.lang.String key, JsonData value)	Add a key/value to settings(Map), creating the map if needed.
PutTemplateRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> value)	Configuration options for the index.
PutTemplateRequest.Builder	timeout(java.lang.String value)	API name: timeout
PutTemplateRequest.Builder	version(java.lang.Long value)	Version number used to manage index templates externally.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

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

Required - The name of the template

API name: name

create

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

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

API name: create

flatSettings

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

API name: flat_settings

includeTypeName

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

Whether a type should be returned in the body of the mappings.

API name: include_type_name

masterTimeout

public PutTemplateRequest.Builder masterTimeout(@Nullable
java.lang.String value)

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

timeout

public PutTemplateRequest.Builder timeout(@Nullable
java.lang.String value)

API name: timeout

aliases

public PutTemplateRequest.Builder aliases(@Nullable
java.util.Map<java.lang.String,Alias> value)

Aliases for the index.

API name: aliases

putAliases

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

Add a key/value to aliases(Map), creating the map if needed.

aliases

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

Set aliases(Map) to a singleton map.

putAliases

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

Add a key/value to aliases(Map), creating the map if needed.

indexPatterns

public PutTemplateRequest.Builder indexPatterns(@Nullable
java.util.List<java.lang.String> value)

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

API name: index_patterns

indexPatterns

public PutTemplateRequest.Builder indexPatterns(java.lang.String... value)

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

API name: index_patterns

addIndexPatterns

public PutTemplateRequest.Builder addIndexPatterns(java.lang.String value)

Add a value to indexPatterns(List), creating the list if needed.

mappings

public PutTemplateRequest.Builder mappings(@Nullable
TypeMapping value)

Mapping for fields in the index.

API name: mappings

mappings

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

Mapping for fields in the index.

API name: mappings

order

public 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 PutTemplateRequest.Builder settings(@Nullable
java.util.Map<java.lang.String,JsonData> value)

Configuration options for the index.

API name: settings

putSettings

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

Add a key/value to settings(Map), creating the map if needed.

version

public 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.