Package org.opensearch.client.opensearch.indices

Class IndexState.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexState.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexState

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

Builder for IndexState.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexState.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	The aliases associated with the index.
final IndexState.Builder	aliases(String key, Alias value)	The aliases associated with the index.
final IndexState.Builder	aliases(Map<String,Alias> map)	The aliases associated with the index.
IndexState	build()	Builds a IndexState.
IndexState.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexState.Builder	dataStream(String value)	API name: data_stream
final IndexState.Builder	defaults(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: defaults
final IndexState.Builder	defaults(IndexSettings value)	API name: defaults
final IndexState.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final IndexState.Builder	mappings(TypeMapping value)	API name: mappings
final IndexState.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
final IndexState.Builder	settings(IndexSettings value)	API name: settings

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

Returns:

a new builder instance.

aliases

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

The aliases associated with the index.

API name: aliases

Adds all elements of map to aliases.

aliases

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

The aliases associated with the index.

API name: aliases

Adds an entry to aliases.

aliases

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

The aliases associated with the index.

API name: aliases

Adds a value to aliases using a builder lambda.

dataStream

@Nonnull
public final IndexState.Builder dataStream(@Nullable
 String value)

API name: data_stream

defaults

@Nonnull
public final IndexState.Builder defaults(@Nullable
 IndexSettings value)

API name: defaults

defaults

@Nonnull
public final IndexState.Builder defaults(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: defaults

mappings

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

API name: mappings

mappings

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

API name: mappings

settings

@Nonnull
public final IndexState.Builder settings(@Nullable
 IndexSettings value)

API name: settings

settings

@Nonnull
public final IndexState.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

build

@Nonnull
public IndexState build()

Builds a IndexState.

Specified by:

build in interface ObjectBuilder<IndexState>

Throws:

NullPointerException - if some of the required fields are null.