Package org.opensearch.client.opensearch.cluster

Class PutComponentTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

PutComponentTemplateRequest

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

Builder for PutComponentTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutComponentTemplateRequest.Builder	allowAutoCreate(Boolean value)	This setting overrides the action.auto_create_index cluster setting.
PutComponentTemplateRequest	build()	Builds a PutComponentTemplateRequest.
final PutComponentTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final PutComponentTemplateRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
PutComponentTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutComponentTemplateRequest.Builder	create(Boolean value)	When true, this request cannot replace or update existing component templates.
final PutComponentTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutComponentTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutComponentTemplateRequest.Builder	meta(String key, JsonData value)	API name: _meta
final PutComponentTemplateRequest.Builder	meta(Map<String,JsonData> map)	API name: _meta
final PutComponentTemplateRequest.Builder	name(String value)	Required - The name of the component template to create.
protected PutComponentTemplateRequest.Builder	self()
final PutComponentTemplateRequest.Builder	template(Function<IndexState.Builder,ObjectBuilder<IndexState>> fn)	Required - API name: template
final PutComponentTemplateRequest.Builder	template(IndexState value)	Required - API name: template
final PutComponentTemplateRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A duration.
final PutComponentTemplateRequest.Builder	timeout(Time value)	A duration.
final PutComponentTemplateRequest.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 PutComponentTemplateRequest.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<PutComponentTemplateRequest.Builder,PutComponentTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutComponentTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutComponentTemplateRequest.Builder>

allowAutoCreate

@Nonnull
public final PutComponentTemplateRequest.Builder allowAutoCreate(@Nullable
 Boolean value)

This setting overrides the action.auto_create_index cluster setting. When set to true in a component template, indexes are automatically created using that template. When set to false, data streams matching the component template must always be explicitly created.

API name: allow_auto_create

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

create

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

When true, this request cannot replace or update existing component templates.

API name: create

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

meta

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

API name: _meta

Adds all elements of map to meta.

meta

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

API name: _meta

Adds an entry to meta.

name

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

Required - The name of the component template to create. OpenSearch includes the following built-in component templates: logs-mappings, logs-settings, metrics-mappings, metrics-settings, synthetics-mapping, and synthetics-settings. OpenSearch uses these templates to configure backing indexes for its data streams. If you want to overwrite one of these templates, set the replacement template version to a higher value than the current version. If you want to disable all built-in component and index templates, set stack.templates.enabled to false using the Cluster Update Settings API.

API name: name

template

@Nonnull
public final PutComponentTemplateRequest.Builder template(IndexState value)

Required - API name: template

template

@Nonnull
public final PutComponentTemplateRequest.Builder template(Function<IndexState.Builder,ObjectBuilder<IndexState>> fn)

Required - API name: template

timeout

@Nonnull
public final PutComponentTemplateRequest.Builder timeout(@Nullable
 Time value)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: timeout

timeout

@Nonnull
public final PutComponentTemplateRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: timeout

version

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

API name: version

build

@Nonnull
public PutComponentTemplateRequest build()

Builds a PutComponentTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutComponentTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.