Package org.opensearch.client.opensearch.cluster

Class PutComponentTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.PutComponentTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutComponentTemplateRequest>

Enclosing class:

PutComponentTemplateRequest

public static class PutComponentTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<PutComponentTemplateRequest>

Builder for PutComponentTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutComponentTemplateRequest.Builder	aliases(java.lang.String key, java.util.function.Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)	API name: aliases
PutComponentTemplateRequest.Builder	aliases(java.lang.String key, AliasDefinition value)	API name: aliases
PutComponentTemplateRequest.Builder	aliases(java.util.Map<java.lang.String,AliasDefinition> map)	API name: aliases
PutComponentTemplateRequest	build()	Builds a PutComponentTemplateRequest.
PutComponentTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
PutComponentTemplateRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
PutComponentTemplateRequest.Builder	create(java.lang.Boolean value)	Whether the index template should only be added if new or can also replace an existing one
PutComponentTemplateRequest.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
PutComponentTemplateRequest.Builder	mappings(TypeMapping value)	API name: mappings
PutComponentTemplateRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
PutComponentTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
PutComponentTemplateRequest.Builder	meta(java.lang.String key, JsonData value)	API name: _meta
PutComponentTemplateRequest.Builder	meta(java.util.Map<java.lang.String,JsonData> map)	API name: _meta
PutComponentTemplateRequest.Builder	name(java.lang.String value)	Required - The name of the template
PutComponentTemplateRequest.Builder	settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
PutComponentTemplateRequest.Builder	settings(IndexSettings value)	API name: settings
PutComponentTemplateRequest.Builder	template(java.util.function.Function<IndexState.Builder,ObjectBuilder<IndexState>> fn)	Required - API name: template
PutComponentTemplateRequest.Builder	template(IndexState value)	Required - API name: template
PutComponentTemplateRequest.Builder	version(java.lang.Long value)	API name: version

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

meta

public final PutComponentTemplateRequest.Builder meta(java.util.Map<java.lang.String,JsonData> map)

API name: _meta

Adds all entries of map to meta.

meta

public final PutComponentTemplateRequest.Builder meta(java.lang.String key,
                                                      JsonData value)

API name: _meta

Adds an entry to meta.

aliases

public final PutComponentTemplateRequest.Builder aliases(java.util.Map<java.lang.String,AliasDefinition> map)

API name: aliases

Adds all entries of map to aliases.

aliases

public final PutComponentTemplateRequest.Builder aliases(java.lang.String key,
                                                         AliasDefinition value)

API name: aliases

Adds an entry to aliases.

aliases

public final PutComponentTemplateRequest.Builder aliases(java.lang.String key,
                                                         java.util.function.Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)

API name: aliases

Adds an entry to aliases using a builder lambda.

create

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

Whether the index template should only be added if new or can also replace an existing one

API name: create

mappings

public final PutComponentTemplateRequest.Builder mappings(@Nullable
                                                          TypeMapping value)

API name: mappings

mappings

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

API name: mappings

masterTimeout

@Deprecated
public final PutComponentTemplateRequest.Builder masterTimeout(@Nullable
                                                               Time value)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final PutComponentTemplateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final PutComponentTemplateRequest.Builder clusterManagerTimeout(@Nullable
                                                                       Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final PutComponentTemplateRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

name

public final PutComponentTemplateRequest.Builder name(java.lang.String value)

Required - The name of the template

API name: name

settings

public final PutComponentTemplateRequest.Builder settings(@Nullable
                                                          IndexSettings value)

API name: settings

settings

public final PutComponentTemplateRequest.Builder settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

template

public final PutComponentTemplateRequest.Builder template(IndexState value)

Required - API name: template

template

public final PutComponentTemplateRequest.Builder template(java.util.function.Function<IndexState.Builder,ObjectBuilder<IndexState>> fn)

Required - API name: template

version

public final PutComponentTemplateRequest.Builder version(@Nullable
                                                         java.lang.Long value)

API name: version

build

public PutComponentTemplateRequest build()

Builds a PutComponentTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutComponentTemplateRequest>

Throws:

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