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) API name:allow_auto_create
build()
Builds aSimulateIndexTemplateRequest
.composedOf
(String value, String... values) API name:composed_of
composedOf
(List<String> list) API name:composed_of
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns.dataStream
(DataStreamVisibility value) API name:data_stream
API name:data_stream
includeDefaults
(Boolean value) If true, returns all relevant default configurations for the index template.indexPatterns
(String value, String... values) API name:index_patterns
indexPatterns
(List<String> list) API name:index_patterns
masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.API name:_meta
API name:_meta
Required - Index or template name to simulateAPI name:priority
protected SimulateIndexTemplateRequest.Builder
self()
template
(IndexTemplateMapping value) API name:template
API name:template
API name:version
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
API name:_meta
Adds all entries of
map
tometa
. -
meta
API name:_meta
Adds an entry to
meta
. -
allowAutoCreate
API name:allow_auto_create
-
composedOf
API name:composed_of
Adds all elements of
list
tocomposedOf
. -
composedOf
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
API name:data_stream
-
dataStream
public final SimulateIndexTemplateRequest.Builder dataStream(Function<DataStreamVisibility.Builder, ObjectBuilder<DataStreamVisibility>> fn) API name:data_stream
-
includeDefaults
If true, returns all relevant default configurations for the index template.API name:
include_defaults
-
indexPatterns
API name:index_patterns
Adds all elements of
list
toindexPatterns
. -
indexPatterns
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
API name:priority
-
template
API name:template
-
template
public final SimulateIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder, ObjectBuilder<IndexTemplateMapping>> fn) API name:template
-
version
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.
-