Package org.opensearch.cluster.metadata

Class MappingMetadata

java.lang.Object

org.opensearch.cluster.AbstractDiffable<MappingMetadata>

org.opensearch.cluster.metadata.MappingMetadata

All Implemented Interfaces:

Diffable<MappingMetadata>, org.opensearch.core.common.io.stream.Writeable

@PublicApi(since="1.0.0")
public class MappingMetadata
extends AbstractDiffable<MappingMetadata>

Mapping configuration for a type.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final MappingMetadata	EMPTY_MAPPINGS

Constructor Summary

Constructors

Constructor	Description
MappingMetadata(String type, Map<String,Object> mapping)
MappingMetadata(CompressedXContent mapping)
MappingMetadata(org.opensearch.core.common.io.stream.StreamInput in)
MappingMetadata(DocumentMapper docMapper)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Object>	getSourceAsMap()	Converts the serialized compressed form of the mappings into a parsed map.
int	hashCode()
static Diff<MappingMetadata>	readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
boolean	routingRequired()
CompressedXContent	source()
Map<String,Object>	sourceAsMap()	Converts the serialized compressed form of the mappings into a parsed map.
String	type()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY_MAPPINGS

public static final MappingMetadata EMPTY_MAPPINGS

Constructor Details

MappingMetadata

public MappingMetadata(DocumentMapper docMapper)

MappingMetadata

public MappingMetadata(CompressedXContent mapping)

MappingMetadata

public MappingMetadata(String type,
 Map<String,Object> mapping)

MappingMetadata

public MappingMetadata(org.opensearch.core.common.io.stream.StreamInput in)
                throws IOException

Throws:

IOException

Method Details

type

public String type()

source

public CompressedXContent source()

sourceAsMap

public Map<String,Object> sourceAsMap()
                               throws org.opensearch.OpenSearchParseException

Converts the serialized compressed form of the mappings into a parsed map.

Throws:

org.opensearch.OpenSearchParseException

getSourceAsMap

public Map<String,Object> getSourceAsMap()
                                  throws org.opensearch.OpenSearchParseException

Converts the serialized compressed form of the mappings into a parsed map.

Throws:

org.opensearch.OpenSearchParseException

routingRequired

public boolean routingRequired()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

readDiffFrom

public static Diff<MappingMetadata> readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
                                          throws IOException

Throws:

IOException