Package org.opensearch.client.opensearch.indices

Class IndexSettingsStore.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettingsStore.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexSettingsStore

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

Builder for IndexSettingsStore.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexSettingsStore.Builder	allowMmap(Boolean value)	Whether memory-mapping is allowed.
IndexSettingsStore	build()	Builds a IndexSettingsStore.
IndexSettingsStore.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSettingsStore.Builder	fs(Function<IndexSettingsStoreFs.Builder,ObjectBuilder<IndexSettingsStoreFs>> fn)	API name: fs
final IndexSettingsStore.Builder	fs(IndexSettingsStoreFs value)	API name: fs
final IndexSettingsStore.Builder	hybrid(Function<IndexSettingsStoreHybrid.Builder,ObjectBuilder<IndexSettingsStoreHybrid>> fn)	API name: hybrid
final IndexSettingsStore.Builder	hybrid(IndexSettingsStoreHybrid value)	API name: hybrid
final IndexSettingsStore.Builder	preload(String value, String... values)	The list of files to preload into memory.
final IndexSettingsStore.Builder	preload(List<String> list)	The list of files to preload into memory.
final IndexSettingsStore.Builder	statsRefreshInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: stats_refresh_interval
final IndexSettingsStore.Builder	statsRefreshInterval(Time value)	API name: stats_refresh_interval
final IndexSettingsStore.Builder	type(Function<StorageType.Builder,ObjectBuilder<StorageType>> fn)	Required - API name: type
final IndexSettingsStore.Builder	type(StorageType value)	Required - API name: type

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

Returns:

a new builder instance.

allowMmap

@Nonnull
public final IndexSettingsStore.Builder allowMmap(@Nullable
 Boolean value)

Whether memory-mapping is allowed. You can restrict the use of the mmapfs and the related hybridfs store types with the setting node.store.allow_mmap. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping.

API name: allow_mmap

fs

@Nonnull
public final IndexSettingsStore.Builder fs(@Nullable
 IndexSettingsStoreFs value)

API name: fs

fs

@Nonnull
public final IndexSettingsStore.Builder fs(Function<IndexSettingsStoreFs.Builder,ObjectBuilder<IndexSettingsStoreFs>> fn)

API name: fs

hybrid

@Nonnull
public final IndexSettingsStore.Builder hybrid(@Nullable
 IndexSettingsStoreHybrid value)

API name: hybrid

hybrid

@Nonnull
public final IndexSettingsStore.Builder hybrid(Function<IndexSettingsStoreHybrid.Builder,ObjectBuilder<IndexSettingsStoreHybrid>> fn)

API name: hybrid

preload

@Nonnull
public final IndexSettingsStore.Builder preload(List<String> list)

The list of files to preload into memory.

API name: preload

Adds all elements of list to preload.

preload

@Nonnull
public final IndexSettingsStore.Builder preload(String value,
 String... values)

The list of files to preload into memory.

API name: preload

Adds one or more values to preload.

statsRefreshInterval

@Nonnull
public final IndexSettingsStore.Builder statsRefreshInterval(@Nullable
 Time value)

API name: stats_refresh_interval

statsRefreshInterval

@Nonnull
public final IndexSettingsStore.Builder statsRefreshInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: stats_refresh_interval

type

@Nonnull
public final IndexSettingsStore.Builder type(StorageType value)

Required - API name: type

type

@Nonnull
public final IndexSettingsStore.Builder type(Function<StorageType.Builder,ObjectBuilder<StorageType>> fn)

Required - API name: type

build

@Nonnull
public IndexSettingsStore build()

Builds a IndexSettingsStore.

Specified by:

build in interface ObjectBuilder<IndexSettingsStore>

Throws:

NullPointerException - if some of the required fields are null.