Package org.opensearch.client.opensearch.indices

Class DataStreamIndex.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.DataStreamIndex.Builder

All Implemented Interfaces:

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

Enclosing class:

DataStreamIndex

public static class DataStreamIndex.Builder
extends ObjectBuilderBase
implements CopyableBuilder<DataStreamIndex.Builder,DataStreamIndex>

Builder for DataStreamIndex.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataStreamIndex	build()	Builds a DataStreamIndex.
DataStreamIndex.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DataStreamIndex.Builder	ilmPolicy(String value)	API name: ilm_policy
final DataStreamIndex.Builder	indexName(String value)	Required - API name: index_name
final DataStreamIndex.Builder	indexUuid(String value)	Required - API name: index_uuid
final DataStreamIndex.Builder	managedBy(ManagedBy value)	API name: managed_by
final DataStreamIndex.Builder	preferIlm(Boolean value)	Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

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 DataStreamIndex.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<DataStreamIndex.Builder,DataStreamIndex>

Returns:

a new builder instance.

ilmPolicy

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

API name: ilm_policy

indexName

@Nonnull
public final DataStreamIndex.Builder indexName(String value)

Required - API name: index_name

indexUuid

@Nonnull
public final DataStreamIndex.Builder indexUuid(String value)

Required - API name: index_uuid

managedBy

@Nonnull
public final DataStreamIndex.Builder managedBy(@Nullable
 ManagedBy value)

API name: managed_by

preferIlm

@Nonnull
public final DataStreamIndex.Builder preferIlm(@Nullable
 Boolean value)

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

API name: prefer_ilm

build

@Nonnull
public DataStreamIndex build()

Builds a DataStreamIndex.

Specified by:

build in interface ObjectBuilder<DataStreamIndex>

Throws:

NullPointerException - if some of the required fields are null.