Package co.elastic.clients.elasticsearch.indices

Class DataStreamIndex.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DataStreamIndex.Builder>

co.elastic.clients.elasticsearch.indices.DataStreamIndex.Builder

All Implemented Interfaces:

WithJson<DataStreamIndex.Builder>, ObjectBuilder<DataStreamIndex>

Enclosing class:

DataStreamIndex

public static class DataStreamIndex.Builder
extends WithJsonObjectBuilderBase<DataStreamIndex.Builder>
implements ObjectBuilder<DataStreamIndex>

Builder for DataStreamIndex.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataStreamIndex	build()	Builds a DataStreamIndex.
final DataStreamIndex.Builder	ilmPolicy(String value)	Name of the current ILM lifecycle policy configured for this backing index.
final DataStreamIndex.Builder	indexName(String value)	Required - Name of the backing index.
final DataStreamIndex.Builder	indexUuid(String value)	Required - Universally unique identifier (UUID) for the index.
final DataStreamIndex.Builder	managedBy(ManagedBy value)	Required - Name of the lifecycle system that's currently managing this backing index.
final DataStreamIndex.Builder	preferIlm(boolean value)	Required - Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
protected DataStreamIndex.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

indexName

public final DataStreamIndex.Builder indexName(String value)

Required - Name of the backing index.

API name: index_name

indexUuid

public final DataStreamIndex.Builder indexUuid(String value)

Required - Universally unique identifier (UUID) for the index.

API name: index_uuid

ilmPolicy

public final DataStreamIndex.Builder ilmPolicy(@Nullable
 String value)

Name of the current ILM lifecycle policy configured for this backing index.

API name: ilm_policy

managedBy

public final DataStreamIndex.Builder managedBy(ManagedBy value)

Required - Name of the lifecycle system that's currently managing this backing index.

API name: managed_by

preferIlm

public final DataStreamIndex.Builder preferIlm(boolean value)

Required - Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

API name: prefer_ilm

self

protected DataStreamIndex.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataStreamIndex.Builder>

build

public DataStreamIndex build()

Builds a DataStreamIndex.

Specified by:

build in interface ObjectBuilder<DataStreamIndex>

Throws:

NullPointerException - if some of the required fields are null.