Package org.opensearch.client.opensearch.indices

Class DataStreamIndex

java.lang.Object

org.opensearch.client.opensearch.indices.DataStreamIndex

All Implemented Interfaces:

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

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

The configuration for a data stream's backing index.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static DataStreamIndex.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	ilmPolicy()	API name: ilm_policy
final String	indexName()	Required - API name: index_name
final String	indexUuid()	Required - API name: index_uuid
final ManagedBy	managedBy()	API name: managed_by
static DataStreamIndex	of(Function<DataStreamIndex.Builder,ObjectBuilder<DataStreamIndex>> fn)
final Boolean	preferIlm()	Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
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	setupDataStreamIndexDeserializer(ObjectDeserializer<DataStreamIndex.Builder> op)
DataStreamIndex.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<DataStreamIndex> _DESERIALIZER

Json deserializer for DataStreamIndex

Method Details

of

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

ilmPolicy

@Nullable
public final String ilmPolicy()

API name: ilm_policy

indexName

@Nonnull
public final String indexName()

Required - API name: index_name

indexUuid

@Nonnull
public final String indexUuid()

Required - API name: index_uuid

managedBy

@Nullable
public final ManagedBy managedBy()

API name: managed_by

preferIlm

@Nullable
public final Boolean preferIlm()

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

API name: prefer_ilm

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

Returns:

a new builder instance.

builder

@Nonnull
public static DataStreamIndex.Builder builder()

setupDataStreamIndexDeserializer

protected static void setupDataStreamIndexDeserializer(ObjectDeserializer<DataStreamIndex.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object