Package com.atlassian.confluence.plugins.opensearch

Class OpenSearchFieldMappingWriter

java.lang.Object

com.atlassian.confluence.plugins.opensearch.OpenSearchFieldMappingWriter

All Implemented Interfaces:

FieldMappings.FieldMappingWriter

@ParametersAreNonnullByDefault
public class OpenSearchFieldMappingWriter
extends Object
implements FieldMappings.FieldMappingWriter

Constructor Summary

Constructors

Constructor	Description
OpenSearchFieldMappingWriter(String index, org.opensearch.client.opensearch.OpenSearchClient client, OpenSearchAnalyzerMapper analyzerMapper)

Method Summary

Modifier and Type	Method	Description
boolean	putIfAbsent(FieldMapping mapping)	Create the specified field mapping on the underlying index if it is not already present.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchFieldMappingWriter

public OpenSearchFieldMappingWriter(String index,
                                    org.opensearch.client.opensearch.OpenSearchClient client,
                                    OpenSearchAnalyzerMapper analyzerMapper)

Method Detail

putIfAbsent

public boolean putIfAbsent(FieldMapping mapping)
                    throws SearchIndexAccessException

Description copied from interface: FieldMappings.FieldMappingWriter

Create the specified field mapping on the underlying index if it is not already present.

Specified by:

putIfAbsent in interface FieldMappings.FieldMappingWriter

Returns:

true if the mapping was created on the index, or false if it was already present.

Throws:

SearchIndexAccessException - if the mapping failed to be created