Package org.opensearch.client.opensearch.indices

Class PutTemplateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.indices.PutTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutTemplateRequest>

Enclosing class:

PutTemplateRequest

public static class PutTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<PutTemplateRequest>

Builder for PutTemplateRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutTemplateRequest.Builder	addIndexPatterns(java.lang.String value)	Add a value to indexPatterns(List), creating the list if needed.
PutTemplateRequest.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Set aliases(Map) to a singleton map.
PutTemplateRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> value)	API name: aliases
PutTemplateRequest	build()	Builds a PutTemplateRequest.
PutTemplateRequest.Builder	create(java.lang.Boolean value)	API name: create
PutTemplateRequest.Builder	flatSettings(java.lang.Boolean value)	API name: flat_settings
PutTemplateRequest.Builder	includeTypeName(java.lang.Boolean value)	API name: include_type_name
PutTemplateRequest.Builder	indexPatterns(java.lang.String... value)	API name: index_patterns
PutTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> value)	API name: index_patterns
PutTemplateRequest.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
PutTemplateRequest.Builder	mappings(TypeMapping value)	API name: mappings
PutTemplateRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
PutTemplateRequest.Builder	name(java.lang.String value)	API name: name
PutTemplateRequest.Builder	order(java.lang.Number value)	API name: order
PutTemplateRequest.Builder	putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Add a key/value to aliases(Map), creating the map if needed.
PutTemplateRequest.Builder	putAliases(java.lang.String key, Alias value)	Add a key/value to aliases(Map), creating the map if needed.
PutTemplateRequest.Builder	putSettings(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to settings(Map), creating the map if needed.
PutTemplateRequest.Builder	settings(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: settings
PutTemplateRequest.Builder	timeout(jakarta.json.JsonValue value)	API name: timeout
PutTemplateRequest.Builder	version(java.lang.Number value)	API name: version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

name

public PutTemplateRequest.Builder name(java.lang.String value)

API name: name

create

public PutTemplateRequest.Builder create(@Nullable java.lang.Boolean value)

API name: create

flatSettings

public PutTemplateRequest.Builder flatSettings(@Nullable java.lang.Boolean value)

API name: flat_settings

includeTypeName

public PutTemplateRequest.Builder includeTypeName(@Nullable java.lang.Boolean value)

API name: include_type_name

masterTimeout

public PutTemplateRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

API name: master_timeout

timeout

public PutTemplateRequest.Builder timeout(@Nullable jakarta.json.JsonValue value)

API name: timeout

aliases

public PutTemplateRequest.Builder aliases(@Nullable java.util.Map<java.lang.String,Alias> value)

API name: aliases

putAliases

public PutTemplateRequest.Builder putAliases(java.lang.String key, Alias value)

Add a key/value to aliases(Map), creating the map if needed.

aliases

public PutTemplateRequest.Builder aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Set aliases(Map) to a singleton map.

putAliases

public PutTemplateRequest.Builder putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Add a key/value to aliases(Map), creating the map if needed.

indexPatterns

public PutTemplateRequest.Builder indexPatterns(@Nullable java.util.List<java.lang.String> value)

API name: index_patterns

indexPatterns

public PutTemplateRequest.Builder indexPatterns(java.lang.String... value)

API name: index_patterns

addIndexPatterns

public PutTemplateRequest.Builder addIndexPatterns(java.lang.String value)

Add a value to indexPatterns(List), creating the list if needed.

mappings

public PutTemplateRequest.Builder mappings(@Nullable TypeMapping value)

API name: mappings

mappings

public PutTemplateRequest.Builder mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: mappings

order

public PutTemplateRequest.Builder order(@Nullable java.lang.Number value)

API name: order

settings

public PutTemplateRequest.Builder settings(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: settings

putSettings

public PutTemplateRequest.Builder putSettings(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to settings(Map), creating the map if needed.

version

public PutTemplateRequest.Builder version(@Nullable java.lang.Number value)

API name: version

build

public PutTemplateRequest build()

Builds a PutTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutTemplateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.