Package co.elastic.clients.elasticsearch.indices

Class IndexTemplateSummary

java.lang.Object

co.elastic.clients.elasticsearch.indices.IndexTemplateSummary

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class IndexTemplateSummary
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Map<String,Alias>	aliases()	Aliases to add.
final DataStreamOptionsTemplate	dataStreamOptions()	API name: data_stream_options
final DataStreamLifecycleWithRollover	lifecycle()	API name: lifecycle
final TypeMapping	mappings()	Mapping for fields in the index.
static IndexTemplateSummary	of(Function<IndexTemplateSummary.Builder,ObjectBuilder<IndexTemplateSummary>> 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()	Configuration options for the index.
protected static void	setupIndexTemplateSummaryDeserializer(ObjectDeserializer<IndexTemplateSummary.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<IndexTemplateSummary> _DESERIALIZER

Json deserializer for IndexTemplateSummary

Method Details

of

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

aliases

public final Map<String,Alias> aliases()

Aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.

API name: aliases

mappings

@Nullable
public final TypeMapping mappings()

Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.

API name: mappings

settings

@Nullable
public final IndexSettings settings()

Configuration options for the index.

API name: settings

lifecycle

@Nullable
public final DataStreamLifecycleWithRollover lifecycle()

API name: lifecycle

dataStreamOptions

@Nullable
public final DataStreamOptionsTemplate dataStreamOptions()

API name: data_stream_options

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

setupIndexTemplateSummaryDeserializer

protected static void setupIndexTemplateSummaryDeserializer(ObjectDeserializer<IndexTemplateSummary.Builder> op)