Package org.opensearch.client.opensearch.indices

Class IndexSettingsStore

java.lang.Object

org.opensearch.client.opensearch.indices.IndexSettingsStore

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<IndexSettingsStore.Builder,IndexSettingsStore>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class IndexSettingsStore
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<IndexSettingsStore.Builder,IndexSettingsStore>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexSettingsStore.Builder	Builder for IndexSettingsStore.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<IndexSettingsStore>	_DESERIALIZER	Json deserializer for IndexSettingsStore

Method Summary

Modifier and Type	Method	Description
final Boolean	allowMmap()	Whether memory-mapping is allowed.
static IndexSettingsStore.Builder	builder()
boolean	equals(Object o)
final IndexSettingsStoreFs	fs()	API name: fs
int	hashCode()
final IndexSettingsStoreHybrid	hybrid()	API name: hybrid
static IndexSettingsStore	of(Function<IndexSettingsStore.Builder,ObjectBuilder<IndexSettingsStore>> fn)
final List<String>	preload()	The list of files to preload into memory.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupIndexSettingsStoreDeserializer(ObjectDeserializer<IndexSettingsStore.Builder> op)
final Time	statsRefreshInterval()	API name: stats_refresh_interval
IndexSettingsStore.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final StorageType	type()	Required - API name: type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<IndexSettingsStore> _DESERIALIZER

Json deserializer for IndexSettingsStore

Method Details

of

public static IndexSettingsStore of(Function<IndexSettingsStore.Builder,ObjectBuilder<IndexSettingsStore>> fn)

allowMmap

@Nullable
public final Boolean allowMmap()

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

@Nullable
public final IndexSettingsStoreFs fs()

API name: fs

hybrid

@Nullable
public final IndexSettingsStoreHybrid hybrid()

API name: hybrid

preload

@Nonnull
public final List<String> preload()

The list of files to preload into memory.

API name: preload

statsRefreshInterval

@Nullable
public final Time statsRefreshInterval()

API name: stats_refresh_interval

type

@Nonnull
public final StorageType type()

Required - API name: type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public IndexSettingsStore.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<IndexSettingsStore.Builder,IndexSettingsStore>

Returns:

a new builder instance.

builder

@Nonnull
public static IndexSettingsStore.Builder builder()

setupIndexSettingsStoreDeserializer

protected static void setupIndexSettingsStoreDeserializer(ObjectDeserializer<IndexSettingsStore.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object