Package org.opensearch.client.opensearch.indices

Class IndexTemplateSummary

java.lang.Object

org.opensearch.client.opensearch.indices.IndexTemplateSummary

All Implemented Interfaces:

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

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

The summary configuration for an index template.

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()	The aliases to add.
static IndexTemplateSummary.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final TypeMapping	mappings()	API name: mappings
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()	API name: settings
protected static void	setupIndexTemplateSummaryDeserializer(ObjectDeserializer<IndexTemplateSummary.Builder> op)
IndexTemplateSummary.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<IndexTemplateSummary> _DESERIALIZER

Json deserializer for IndexTemplateSummary

Method Details

of

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

aliases

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

The 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()

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

Returns:

a new builder instance.

builder

@Nonnull
public static IndexTemplateSummary.Builder builder()

setupIndexTemplateSummaryDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object