Class PutTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<PutTemplateRequest.Builder>
co.elastic.clients.elasticsearch.indices.PutTemplateRequest.Builder
- All Implemented Interfaces:
WithJson<PutTemplateRequest.Builder>
,ObjectBuilder<PutTemplateRequest>
- Enclosing class:
- PutTemplateRequest
public static class PutTemplateRequest.Builder extends WithJsonObjectBuilderBase<PutTemplateRequest.Builder> 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, Alias value)
Aliases for the index.PutTemplateRequest.Builder
aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)
Aliases for the index.PutTemplateRequest.Builder
aliases(java.util.Map<java.lang.String,Alias> map)
Aliases for the index.PutTemplateRequest
build()
Builds aPutTemplateRequest
.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(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(Time value)
Period to wait for a connection to the master node.PutTemplateRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.PutTemplateRequest.Builder
name(java.lang.String value)
Required - The name of the templatePutTemplateRequest.Builder
order(java.lang.Integer value)
Order in which Elasticsearch applies this template if index matches multiple templates.protected PutTemplateRequest.Builder
self()
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(Time value)
API name:timeout
PutTemplateRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
API name:timeout
PutTemplateRequest.Builder
version(java.lang.Long value)
Version number used to manage index templates externally.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.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 Details
-
Builder
public Builder()
-
-
Method Details
-
aliases
Aliases for the index.API name:
aliases
Adds all entries of
map
toaliases
. -
aliases
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
If true, this request cannot replace or update existing index templates.API name:
create
-
flatSettings
API name:flat_settings
-
indexPatterns
Array of wildcard expressions used to match the names of indices during creation.API name:
index_patterns
Adds all elements of
list
toindexPatterns
. -
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
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
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
public final PutTemplateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)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
-
name
Required - The name of the templateAPI name:
name
-
order
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
Configuration options for the index.API name:
settings
Adds all entries of
map
tosettings
. -
settings
Configuration options for the index.API name:
settings
Adds an entry to
settings
. -
timeout
API name:timeout
-
timeout
public final PutTemplateRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)API name:timeout
-
version
Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.API name:
version
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<PutTemplateRequest.Builder>
-
build
Builds aPutTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTemplateRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-