Class SimulateIndexTemplateRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>
org.opensearch.client.opensearch.indices.SimulateIndexTemplateRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<SimulateIndexTemplateRequest.Builder,,SimulateIndexTemplateRequest> MutableBuilder<SimulateIndexTemplateRequest.Builder,,SimulateIndexTemplateRequest> ObjectBuilder<SimulateIndexTemplateRequest>
- Enclosing class:
SimulateIndexTemplateRequest
public static class SimulateIndexTemplateRequest.Builder
extends RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>
implements CopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>
Builder for
SimulateIndexTemplateRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowAutoCreate(Boolean value) This setting overrides the value of theaction.auto_create_indexcluster setting.build()Builds aSimulateIndexTemplateRequest.Operation timeout for connection to cluster-manager node.clusterManagerTimeout(Time value) Operation timeout for connection to cluster-manager node.composedOf(String value, String... values) An ordered list of component template names.composedOf(List<String> list) An ordered list of component template names.copy()Create a new builderCopyableBuilderthat is a copy of this one.dataStream(Function<IndexTemplateDataStreamConfiguration.Builder, ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn) API name:data_streamAPI name:data_streamindexPatterns(String value, String... values) API name:index_patternsindexPatterns(List<String> list) API name:index_patternsDeprecated.masterTimeout(Time value) Deprecated.API name:_metaAPI name:_metaRequired - Index or template name to simulatePriority to determine index template precedence when a new data stream or index is created.protected SimulateIndexTemplateRequest.Builderself()API name:templatetemplate(IndexTemplateMapping value) API name:templateAPI name:versionMethods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>
-
allowAutoCreate
This setting overrides the value of theaction.auto_create_indexcluster setting. If set totruein a template, then indexes can be automatically created using that template even if auto-creation of indexes is disabled usingactions.auto_create_index. If set tofalse, then indexes or data streams matching the template must always be explicitly created, and may never be automatically created.API name:
allow_auto_create -
clusterManagerTimeout
@Nonnull public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(@Nullable Time value) Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
clusterManagerTimeout
@Nonnull public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
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_ofAdds all elements of
listtocomposedOf. -
composedOf
@Nonnull public final SimulateIndexTemplateRequest.Builder composedOf(String value, String... values) 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_ofAdds one or more values to
composedOf. -
dataStream
@Nonnull public final SimulateIndexTemplateRequest.Builder dataStream(@Nullable IndexTemplateDataStreamConfiguration value) API name:data_stream -
dataStream
@Nonnull public final SimulateIndexTemplateRequest.Builder dataStream(Function<IndexTemplateDataStreamConfiguration.Builder, ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn) API name:data_stream -
indexPatterns
API name:index_patternsAdds all elements of
listtoindexPatterns. -
indexPatterns
@Nonnull public final SimulateIndexTemplateRequest.Builder indexPatterns(String value, String... values) API name:index_patternsAdds one or more values to
indexPatterns. -
masterTimeout
@Deprecated @Nonnull public final SimulateIndexTemplateRequest.Builder masterTimeout(@Nullable Time value) Deprecated.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:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final SimulateIndexTemplateRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.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:
master_timeout -
meta
API name:_metaAdds all elements of
maptometa. -
meta
API name:_metaAdds an entry to
meta. -
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 OpenSearch.API name:
priority -
template
@Nonnull public final SimulateIndexTemplateRequest.Builder template(@Nullable IndexTemplateMapping value) API name:template -
template
@Nonnull public final SimulateIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder, ObjectBuilder<IndexTemplateMapping>> fn) API name:template -
version
API name:version -
build
Builds aSimulateIndexTemplateRequest.- Specified by:
buildin interfaceObjectBuilder<SimulateIndexTemplateRequest>- Throws:
NullPointerException- if some of the required fields are null.
-