Package org.opensearch.client.opensearch.indices

Class TemplateMapping

java.lang.Object

org.opensearch.client.opensearch.indices.TemplateMapping

All Implemented Interfaces:

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

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

The mapping configuration for a template.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Map<String,Alias>	aliases()	Required - API name: aliases
static TemplateMapping.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	indexPatterns()	Required - API name: index_patterns
final TypeMapping	mappings()	Required - API name: mappings
static TemplateMapping	of(Function<TemplateMapping.Builder,ObjectBuilder<TemplateMapping>> fn)
final int	order()	Required - The order in which the template should be applied.
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 Map<String,JsonData>	settings()	Required - The index settings to apply.
protected static void	setupTemplateMappingDeserializer(ObjectDeserializer<TemplateMapping.Builder> op)
TemplateMapping.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version

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<TemplateMapping> _DESERIALIZER

Json deserializer for TemplateMapping

Method Details

of

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

aliases

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

Required - API name: aliases

indexPatterns

@Nonnull
public final List<String> indexPatterns()

Required - API name: index_patterns

mappings

@Nonnull
public final TypeMapping mappings()

Required - API name: mappings

order

public final int order()

Required - The order in which the template should be applied.

API name: order

settings

@Nonnull
public final Map<String,JsonData> settings()

Required - The index settings to apply.

API name: settings

version

@Nullable
public final Long version()

API name: version

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

Returns:

a new builder instance.

builder

@Nonnull
public static TemplateMapping.Builder builder()

setupTemplateMappingDeserializer

protected static void setupTemplateMappingDeserializer(ObjectDeserializer<TemplateMapping.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object