Package org.nuxeo.runtime.opensearch1

Class OpenSearchIndexConfig

java.lang.Object
org.nuxeo.runtime.opensearch1.OpenSearchIndexConfig
All Implemented Interfaces:
Descriptor
public class OpenSearchIndexConfig extends Object implements Descriptor
XMap descriptor for configuring an index
Author:
Tiry

  • Field Details

    • DEFAULT_SETTING_FILE

      public static final String DEFAULT_SETTING_FILE
      See Also:

    • DEFAULT_MAPPING_FILE

      public static final String DEFAULT_MAPPING_FILE
      See Also:

    • WRITE_SUFFIX

      protected static final String WRITE_SUFFIX
      See Also:

    • name

      protected String name

    • enabled

      protected Boolean enabled

    • create

      protected Boolean create

    • manageAlias

      protected Boolean manageAlias

    • writeAlias

      protected String writeAlias

    • clientIds

      protected List<String> clientIds

    • settingsContent

      protected String settingsContent

    • mappingContent

      protected String mappingContent

    • extraMappingContents

      protected List<String> extraMappingContents

    • mappingAppend

      protected boolean mappingAppend

  • Constructor Details

    • OpenSearchIndexConfig

      public OpenSearchIndexConfig()

  • Method Details

    • getId

      public String getId()
      Description copied from interface: Descriptor
      The descriptor id, descriptors with same id are merged.

      To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

      To forbid merge use a unique value, non-overriden toString() for exemple.

      Specified by:
      getId in interface Descriptor

    • getName

      public String getName()
      Returns:
      the index name

    • isEnabled

      public boolean isEnabled()

    • mustCreate

      public boolean mustCreate()

    • manageAlias

      public boolean manageAlias()

    • hasExplicitWriteIndex

      public boolean hasExplicitWriteIndex()

    • writeIndexOrAlias

      public String writeIndexOrAlias()

    • newWriteIndexForAlias

      public String newWriteIndexForAlias(String aliasName, String oldIndexName)

    • getClientIds

      public List<String> getClientIds()

    • getSettingsContent

      public String getSettingsContent()

    • setSettings

      protected void setSettings(String settings)

    • setSettingsFile

      protected void setSettingsFile(String settingsFile)

    • getMappingContent

      public String getMappingContent()

    • setMapping

      protected void setMapping(String mapping)

    • setMappingFile

      protected void setMappingFile(String mappingFile)

    • getExtraMappingContents

      public List<String> getExtraMappingContents()

    • contentOfFile

      protected String contentOfFile(String filename)

    • getResourceStream

      protected InputStream getResourceStream(String filename)

    • merge

      public OpenSearchIndexConfig merge(Descriptor o)
      Use other mapping and settings if not defined.
      Specified by:
      merge in interface Descriptor
      Returns:
      the merged descriptor

    • toString

      public String toString()
      Overrides:
      toString in class Object