Class IndexTemplateMapping.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.put_index_template.IndexTemplateMapping.Builder
- All Implemented Interfaces:
PlainDeserializable<IndexTemplateMapping.Builder>,CopyableBuilder<IndexTemplateMapping.Builder,,IndexTemplateMapping> MutableBuilder<IndexTemplateMapping.Builder,,IndexTemplateMapping> ObjectBuilder<IndexTemplateMapping>
- Enclosing class:
IndexTemplateMapping
public static class IndexTemplateMapping.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndexTemplateMapping.Builder,IndexTemplateMapping>, PlainDeserializable<IndexTemplateMapping.Builder>
Builder for
IndexTemplateMapping.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) The aliases to add.The aliases to add.The aliases to add.build()Builds aIndexTemplateMapping.copy()Create a new builderCopyableBuilderthat is a copy of this one.API name:mappingsmappings(TypeMapping value) API name:mappingsself()API name:settingssettings(IndexSettings value) API name:settingsMethods 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
applyMutationMethods inherited from interface org.opensearch.client.json.PlainDeserializable
withJson, withJson, withJson
-
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<IndexTemplateMapping.Builder,IndexTemplateMapping> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin interfacePlainDeserializable<IndexTemplateMapping.Builder>
-
aliases
The aliases to add. If the index template includes adata_streamobject, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore theindex_routing,routing, andsearch_routingoptions.API name:
aliasesAdds all elements of
maptoaliases. -
aliases
The aliases to add. If the index template includes adata_streamobject, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore theindex_routing,routing, andsearch_routingoptions.API name:
aliasesAdds an entry to
aliases. -
aliases
@Nonnull public final IndexTemplateMapping.Builder aliases(String key, Function<Alias.Builder, ObjectBuilder<Alias>> fn) The aliases to add. If the index template includes adata_streamobject, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore theindex_routing,routing, andsearch_routingoptions.API name:
aliasesAdds a value to
aliasesusing a builder lambda. -
mappings
API name:mappings -
mappings
@Nonnull public final IndexTemplateMapping.Builder mappings(Function<TypeMapping.Builder, ObjectBuilder<TypeMapping>> fn) API name:mappings -
settings
API name:settings -
settings
@Nonnull public final IndexTemplateMapping.Builder settings(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) API name:settings -
build
Builds aIndexTemplateMapping.- Specified by:
buildin interfaceObjectBuilder<IndexTemplateMapping>- Throws:
NullPointerException- if some of the required fields are null.
-