Class SimulateIndexTemplateRequest.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.indices.SimulateIndexTemplateRequest.Builder
-
- All Implemented Interfaces:
ObjectBuilder<SimulateIndexTemplateRequest>
- Enclosing class:
- SimulateIndexTemplateRequest
public static class SimulateIndexTemplateRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<SimulateIndexTemplateRequest>
Builder forSimulateIndexTemplateRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SimulateIndexTemplateRequest.BuilderallowAutoCreate(java.lang.Boolean value)API name:allow_auto_createSimulateIndexTemplateRequestbuild()Builds aSimulateIndexTemplateRequest.SimulateIndexTemplateRequest.BuilderclusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Period to wait for a connection to the cluster-manager node.SimulateIndexTemplateRequest.BuilderclusterManagerTimeout(Time value)Period to wait for a connection to the cluster-manager node.SimulateIndexTemplateRequest.BuildercomposedOf(java.lang.String value, java.lang.String... values)API name:composed_ofSimulateIndexTemplateRequest.BuildercomposedOf(java.util.List<java.lang.String> list)API name:composed_ofSimulateIndexTemplateRequest.Buildercreate(java.lang.Boolean value)Iftrue, the template passed in the body is only used if no existing templates match the same index patterns.SimulateIndexTemplateRequest.BuilderdataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> fn)API name:data_streamSimulateIndexTemplateRequest.BuilderdataStream(DataStream value)API name:data_streamSimulateIndexTemplateRequest.BuilderindexPatterns(java.lang.String value, java.lang.String... values)API name:index_patternsSimulateIndexTemplateRequest.BuilderindexPatterns(java.util.List<java.lang.String> list)API name:index_patternsSimulateIndexTemplateRequest.BuildermasterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Deprecated.SimulateIndexTemplateRequest.BuildermasterTimeout(Time value)Deprecated.SimulateIndexTemplateRequest.Buildermeta(java.lang.String key, JsonData value)API name:_metaSimulateIndexTemplateRequest.Buildermeta(java.util.Map<java.lang.String,JsonData> map)API name:_metaSimulateIndexTemplateRequest.Buildername(java.lang.String value)Required - Index or template name to simulateSimulateIndexTemplateRequest.Builderpriority(java.lang.Integer value)API name:prioritySimulateIndexTemplateRequest.Buildertemplate(java.util.function.Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)API name:templateSimulateIndexTemplateRequest.Buildertemplate(IndexTemplateMapping value)API name:templateSimulateIndexTemplateRequest.Builderversion(java.lang.Long value)API name:version-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
meta
public final SimulateIndexTemplateRequest.Builder meta(java.util.Map<java.lang.String,JsonData> map)
API name:_metaAdds all entries of
maptometa.
-
meta
public final SimulateIndexTemplateRequest.Builder meta(java.lang.String key, JsonData value)
API name:_metaAdds an entry to
meta.
-
allowAutoCreate
public final SimulateIndexTemplateRequest.Builder allowAutoCreate(@Nullable java.lang.Boolean value)
API name:allow_auto_create
-
composedOf
public final SimulateIndexTemplateRequest.Builder composedOf(java.util.List<java.lang.String> list)
API name:composed_ofAdds all elements of
listtocomposedOf.
-
composedOf
public final SimulateIndexTemplateRequest.Builder composedOf(java.lang.String value, java.lang.String... values)
API name:composed_ofAdds one or more values to
composedOf.
-
create
public final SimulateIndexTemplateRequest.Builder create(@Nullable java.lang.Boolean value)
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
public final SimulateIndexTemplateRequest.Builder dataStream(@Nullable DataStream value)
API name:data_stream
-
dataStream
public final SimulateIndexTemplateRequest.Builder dataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> fn)
API name:data_stream
-
indexPatterns
public final SimulateIndexTemplateRequest.Builder indexPatterns(java.util.List<java.lang.String> list)
API name:index_patternsAdds all elements of
listtoindexPatterns.
-
indexPatterns
public final SimulateIndexTemplateRequest.Builder indexPatterns(java.lang.String value, java.lang.String... values)
API name:index_patternsAdds one or more values to
indexPatterns.
-
masterTimeout
@Deprecated public final SimulateIndexTemplateRequest.Builder masterTimeout(@Nullable Time value)
Deprecated.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
@Deprecated public final SimulateIndexTemplateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Deprecated.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
-
clusterManagerTimeout
public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(@Nullable Time value)
Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
cluster_manager_timeout
-
clusterManagerTimeout
public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
cluster_manager_timeout
-
name
public final SimulateIndexTemplateRequest.Builder name(java.lang.String value)
Required - Index or template name to simulateAPI name:
name
-
priority
public final SimulateIndexTemplateRequest.Builder priority(@Nullable java.lang.Integer value)
API name:priority
-
template
public final SimulateIndexTemplateRequest.Builder template(@Nullable IndexTemplateMapping value)
API name:template
-
template
public final SimulateIndexTemplateRequest.Builder template(java.util.function.Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)
API name:template
-
version
public final SimulateIndexTemplateRequest.Builder version(@Nullable java.lang.Long value)
API name:version
-
build
public SimulateIndexTemplateRequest build()
Builds aSimulateIndexTemplateRequest.- Specified by:
buildin interfaceObjectBuilder<SimulateIndexTemplateRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-