Package co.elastic.clients.elasticsearch.indices.get_data_stream_settings

Class DataStreamSettings

java.lang.Object

co.elastic.clients.elasticsearch.indices.get_data_stream_settings.DataStreamSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataStreamSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final IndexSettings	effectiveSettings()	Required - The settings specific to this data stream merged with the settings from its template.
final String	name()	Required - The name of the data stream.
static DataStreamSettings	of(Function<DataStreamSettings.Builder,ObjectBuilder<DataStreamSettings>> 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()	Required - The settings specific to this data stream
protected static void	setupDataStreamSettingsDeserializer(ObjectDeserializer<DataStreamSettings.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<DataStreamSettings> _DESERIALIZER

Json deserializer for DataStreamSettings

Method Details

of

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

name

public final String name()

Required - The name of the data stream.

API name: name

settings

public final IndexSettings settings()

Required - The settings specific to this data stream

API name: settings

effectiveSettings

public final IndexSettings effectiveSettings()

Required - The settings specific to this data stream merged with the settings from its template. These effective_settings are the settings that will be used when a new index is created for this data stream.

API name: effective_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)

toString

public String toString()

Overrides:

toString in class Object

setupDataStreamSettingsDeserializer

protected static void setupDataStreamSettingsDeserializer(ObjectDeserializer<DataStreamSettings.Builder> op)