Package org.opensearch.client.opensearch.indices

Class PutTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutTemplateRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>, MutableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>, ObjectBuilder<PutTemplateRequest>

Enclosing class:

PutTemplateRequest

public static class PutTemplateRequest.Builder
extends RequestBase.AbstractBuilder<PutTemplateRequest.Builder>
implements CopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>

Builder for PutTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutTemplateRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases for the index.
final PutTemplateRequest.Builder	aliases(String key, Alias value)	Aliases for the index.
final PutTemplateRequest.Builder	aliases(Map<String,Alias> map)	Aliases for the index.
PutTemplateRequest	build()	Builds a PutTemplateRequest.
final PutTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
PutTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutTemplateRequest.Builder	create(Boolean value)	If true, this request cannot replace or update existing index templates.
final PutTemplateRequest.Builder	indexPatterns(String value, String... values)	Array of wildcard expressions used to match the names of indexes during creation.
final PutTemplateRequest.Builder	indexPatterns(List<String> list)	Array of wildcard expressions used to match the names of indexes during creation.
final PutTemplateRequest.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final PutTemplateRequest.Builder	mappings(TypeMapping value)	API name: mappings
final PutTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutTemplateRequest.Builder	name(String value)	Required - The name of the template
final PutTemplateRequest.Builder	order(Integer value)	Order in which OpenSearch applies this template if index matches multiple templates.
protected PutTemplateRequest.Builder	self()
final PutTemplateRequest.Builder	settings(String key, JsonData value)	Configuration options for the index.
final PutTemplateRequest.Builder	settings(Map<String,JsonData> map)	Configuration options for the index.
final PutTemplateRequest.Builder	version(Long value)	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PutTemplateRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PutTemplateRequest.Builder,PutTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutTemplateRequest.Builder>

aliases

@Nonnull
public final PutTemplateRequest.Builder aliases(Map<String,Alias> map)

Aliases for the index.

API name: aliases

Adds all elements of map to aliases.

aliases

@Nonnull
public final PutTemplateRequest.Builder aliases(String key,
 Alias value)

Aliases for the index.

API name: aliases

Adds an entry to aliases.

aliases

@Nonnull
public final PutTemplateRequest.Builder aliases(String key,
 Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Aliases for the index.

API name: aliases

Adds a value to aliases using a builder lambda.

clusterManagerTimeout

@Nonnull
public final PutTemplateRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PutTemplateRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

create

@Nonnull
public final PutTemplateRequest.Builder create(@Nullable
 Boolean value)

If true, this request cannot replace or update existing index templates.

API name: create

indexPatterns

@Nonnull
public final PutTemplateRequest.Builder indexPatterns(List<String> list)

Array of wildcard expressions used to match the names of indexes during creation.

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

@Nonnull
public final PutTemplateRequest.Builder indexPatterns(String value,
 String... values)

Array of wildcard expressions used to match the names of indexes during creation.

API name: index_patterns

Adds one or more values to indexPatterns.

mappings

@Nonnull
public final PutTemplateRequest.Builder mappings(@Nullable
 TypeMapping value)

API name: mappings

mappings

@Nonnull
public final PutTemplateRequest.Builder mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: mappings

masterTimeout

@Deprecated
@Nonnull
public final PutTemplateRequest.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 PutTemplateRequest.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

name

@Nonnull
public final PutTemplateRequest.Builder name(String value)

Required - The name of the template

API name: name

order

@Nonnull
public final PutTemplateRequest.Builder order(@Nullable
 Integer value)

Order in which OpenSearch applies this template if index matches multiple templates.

Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values.

API name: order

settings

@Nonnull
public final PutTemplateRequest.Builder settings(Map<String,JsonData> map)

Configuration options for the index.

API name: settings

Adds all elements of map to settings.

settings

@Nonnull
public final PutTemplateRequest.Builder settings(String key,
 JsonData value)

Configuration options for the index.

API name: settings

Adds an entry to settings.

version

@Nonnull
public final PutTemplateRequest.Builder version(@Nullable
 Long value)

API name: version

build

@Nonnull
public PutTemplateRequest build()

Builds a PutTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.