Class SimulateIndexTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>
co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest.Builder
- All Implemented Interfaces:
WithJson<SimulateIndexTemplateRequest.Builder>
,ObjectBuilder<SimulateIndexTemplateRequest>
- Enclosing class:
- SimulateIndexTemplateRequest
public static class SimulateIndexTemplateRequest.Builder
extends RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>
implements ObjectBuilder<SimulateIndexTemplateRequest>
Builder for
SimulateIndexTemplateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowAutoCreate
(Boolean value) This setting overrides the value of theaction.auto_create_index
cluster setting.build()
Builds aSimulateIndexTemplateRequest
.composedOf
(String value, String... values) An ordered list of component template names.composedOf
(List<String> list) An ordered list of component template names.Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns.dataStream
(DataStreamVisibility value) If this object is included, the template is used to create data streams and their backing indices.If this object is included, the template is used to create data streams and their backing indices.includeDefaults
(Boolean value) If true, returns all relevant default configurations for the index template.indexPatterns
(String value, String... values) Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.indexPatterns
(List<String> list) Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Optional user metadata about the index template.Optional user metadata about the index template.Required - Index or template name to simulatePriority to determine index template precedence when a new data stream or index is created.protected SimulateIndexTemplateRequest.Builder
self()
template
(IndexTemplateMapping value) Template to be applied.Template to be applied.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
-
meta
Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
Adds all entries of
map
tometa
. -
meta
Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
Adds an entry to
meta
. -
allowAutoCreate
This setting overrides the value of theaction.auto_create_index
cluster setting. If set totrue
in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled viaactions.auto_create_index
. If set tofalse
, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.API name:
allow_auto_create
-
composedOf
An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.API name:
composed_of
Adds all elements of
list
tocomposedOf
. -
composedOf
An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.API name:
composed_of
Adds one or more values to
composedOf
. -
create
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns. Iffalse
, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.API name:
create
-
dataStream
If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with adata_stream
object.API name:
data_stream
-
dataStream
public final SimulateIndexTemplateRequest.Builder dataStream(Function<DataStreamVisibility.Builder, ObjectBuilder<DataStreamVisibility>> fn) If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with adata_stream
object.API name:
data_stream
-
includeDefaults
If true, returns all relevant default configurations for the index template.API name:
include_defaults
-
indexPatterns
Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.API name:
index_patterns
Adds all elements of
list
toindexPatterns
. -
indexPatterns
Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.API name:
index_patterns
Adds one or more values to
indexPatterns
. -
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 SimulateIndexTemplateRequest.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 - Index or template name to simulateAPI name:
name
-
priority
Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.API name:
priority
-
template
Template to be applied. It may optionally include analiases
,mappings
, orsettings
configuration.API name:
template
-
template
public final SimulateIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder, ObjectBuilder<IndexTemplateMapping>> fn) Template to be applied. It may optionally include analiases
,mappings
, orsettings
configuration.API name:
template
-
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<SimulateIndexTemplateRequest.Builder>
-
build
Builds aSimulateIndexTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<SimulateIndexTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-