Package org.opensearch.client.opensearch.indices

Class PutIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.PutIndexTemplateRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PutIndexTemplateRequest

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

Builder for PutIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutIndexTemplateRequest	build()	Builds a PutIndexTemplateRequest.
final PutIndexTemplateRequest.Builder	cause(String value)	User defined reason for creating/updating the index template.
final PutIndexTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutIndexTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
final PutIndexTemplateRequest.Builder	composedOf(String value, String... values)	An ordered list of component template names.
final PutIndexTemplateRequest.Builder	composedOf(List<String> list)	An ordered list of component template names.
PutIndexTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutIndexTemplateRequest.Builder	create(Boolean value)	If true, this request cannot replace or update existing index templates.
final PutIndexTemplateRequest.Builder	dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)	API name: data_stream
final PutIndexTemplateRequest.Builder	dataStream(IndexTemplateDataStreamConfiguration value)	API name: data_stream
final PutIndexTemplateRequest.Builder	indexPatterns(String value, String... values)	API name: index_patterns
final PutIndexTemplateRequest.Builder	indexPatterns(List<String> list)	API name: index_patterns
final PutIndexTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutIndexTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutIndexTemplateRequest.Builder	meta(String key, JsonData value)	API name: _meta
final PutIndexTemplateRequest.Builder	meta(Map<String,JsonData> map)	API name: _meta
final PutIndexTemplateRequest.Builder	name(String value)	Required - Index or template name
final PutIndexTemplateRequest.Builder	priority(Integer value)	Priority to determine index template precedence when a new data stream or index is created.
protected PutIndexTemplateRequest.Builder	self()
final PutIndexTemplateRequest.Builder	template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	API name: template
final PutIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	API name: template
final PutIndexTemplateRequest.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 PutIndexTemplateRequest.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<PutIndexTemplateRequest.Builder,PutIndexTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutIndexTemplateRequest.Builder>

cause

@Nonnull
public final PutIndexTemplateRequest.Builder cause(@Nullable
 String value)

User defined reason for creating/updating the index template.

API name: cause

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

composedOf

@Nonnull
public final PutIndexTemplateRequest.Builder composedOf(List<String> list)

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_of

Adds all elements of list to composedOf.

composedOf

@Nonnull
public final PutIndexTemplateRequest.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_of

Adds one or more values to composedOf.

create

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

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

API name: create

dataStream

@Nonnull
public final PutIndexTemplateRequest.Builder dataStream(@Nullable
 IndexTemplateDataStreamConfiguration value)

API name: data_stream

dataStream

@Nonnull
public final PutIndexTemplateRequest.Builder dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)

API name: data_stream

indexPatterns

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

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

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

API name: index_patterns

Adds one or more values to indexPatterns.

masterTimeout

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

Deprecated.

Operation timeout for connection to cluster-manager node.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final PutIndexTemplateRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Operation timeout for connection to cluster-manager node.

API name: master_timeout

meta

@Nonnull
public final PutIndexTemplateRequest.Builder meta(Map<String,JsonData> map)

API name: _meta

Adds all elements of map to meta.

meta

@Nonnull
public final PutIndexTemplateRequest.Builder meta(String key,
 JsonData value)

API name: _meta

Adds an entry to meta.

name

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

Required - Index or template name

API name: name

priority

@Nonnull
public final PutIndexTemplateRequest.Builder priority(@Nullable
 Integer value)

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 PutIndexTemplateRequest.Builder template(@Nullable
 IndexTemplateMapping value)

API name: template

template

@Nonnull
public final PutIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)

API name: template

version

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

API name: version

build

@Nonnull
public PutIndexTemplateRequest build()

Builds a PutIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.