Package co.elastic.clients.elasticsearch.indices

Class DataStreamIndex

java.lang.Object

co.elastic.clients.elasticsearch.indices.DataStreamIndex

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataStreamIndex
extends Object
implements JsonpSerializable

See Also:

• API specification

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
final String	ilmPolicy()	Name of the current ILM lifecycle policy configured for this backing index.
final String	indexName()	Required - Name of the backing index.
final String	indexUuid()	Required - Universally unique identifier (UUID) for the index.
final ManagedBy	managedBy()	Required - Name of the lifecycle system that's currently managing this backing index.
static DataStreamIndex	of(Function<DataStreamIndex.Builder,ObjectBuilder<DataStreamIndex>> fn)
final boolean	preferIlm()	Required - 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)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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)

indexName

public final String indexName()

Required - Name of the backing index.

API name: index_name

indexUuid

public final String indexUuid()

Required - Universally unique identifier (UUID) for the index.

API name: index_uuid

ilmPolicy

@Nullable
public final String ilmPolicy()

Name of the current ILM lifecycle policy configured for this backing index.

API name: ilm_policy

managedBy

public final ManagedBy managedBy()

Required - Name of the lifecycle system that's currently managing this backing index.

API name: managed_by

preferIlm

public final boolean preferIlm()

Required - 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)

toString

public String toString()

Overrides:

toString in class Object

setupDataStreamIndexDeserializer

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