Package org.opensearch.client.opensearch.indices

Class IndexState

java.lang.Object

org.opensearch.client.opensearch.indices.IndexState

All Implemented Interfaces:

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

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

The state configuration of an index.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Map<String,Alias>	aliases()	The aliases associated with the index.
static IndexState.Builder	builder()
final String	dataStream()	API name: data_stream
final IndexSettings	defaults()	API name: defaults
boolean	equals(Object o)
int	hashCode()
final TypeMapping	mappings()	API name: mappings
static IndexState	of(Function<IndexState.Builder,ObjectBuilder<IndexState>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final IndexSettings	settings()	API name: settings
protected static void	setupIndexStateDeserializer(ObjectDeserializer<IndexState.Builder> op)
IndexState.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<IndexState> _DESERIALIZER

Json deserializer for IndexState

Method Details

of

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

aliases

@Nonnull
public final Map<String,Alias> aliases()

The aliases associated with the index.

API name: aliases

dataStream

@Nullable
public final String dataStream()

API name: data_stream

defaults

@Nullable
public final IndexSettings defaults()

API name: defaults

mappings

@Nullable
public final TypeMapping mappings()

API name: mappings

settings

@Nullable
public final IndexSettings settings()

API name: settings

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

Returns:

a new builder instance.

builder

@Nonnull
public static IndexState.Builder builder()

setupIndexStateDeserializer

protected static void setupIndexStateDeserializer(ObjectDeserializer<IndexState.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object