Class PutTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<PutTemplateRequest.Builder>
implements ObjectBuilder<PutTemplateRequest>
Builder for
PutTemplateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAliases for the index.aliases
(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) Aliases for the index.Aliases for the index.build()
Builds aPutTemplateRequest
.If true, this request cannot replace or update existing index templates.flatSettings
(Boolean value) API name:flat_settings
indexPatterns
(String value, String... values) Array of wildcard expressions used to match the names of indices during creation.indexPatterns
(List<String> list) Array of wildcard expressions used to match the names of indices during creation.mappings
(TypeMapping value) Mapping for fields in the index.Mapping for fields in the index.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Required - The name of the templateOrder in which Elasticsearch applies this template if index matches multiple templates.protected PutTemplateRequest.Builder
self()
Configuration options for the index.Configuration options for the index.API name:timeout
API name:timeout
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
-
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(String key, 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
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(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(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
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 classRequestBase.AbstractBuilder<PutTemplateRequest.Builder>
-
build
Builds aPutTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<PutTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-