Module org.elasticsearch.server
Package org.elasticsearch.cluster.metadata

Class DataStreamFailureStoreDefinition

java.lang.Object
org.elasticsearch.cluster.metadata.DataStreamFailureStoreDefinition
public class DataStreamFailureStoreDefinition extends Object
A utility class that contains the mappings and settings logic for failure store indices that are a part of data streams.

  • Field Details

    • FAILURE_STORE_REFRESH_INTERVAL_SETTING_NAME

      public static final String FAILURE_STORE_REFRESH_INTERVAL_SETTING_NAME
      See Also:

    • INDEX_FAILURE_STORE_VERSION_SETTING_NAME

      public static final String INDEX_FAILURE_STORE_VERSION_SETTING_NAME
      See Also:

    • DATA_STREAM_FAILURE_STORE_SETTINGS

      public static final Settings DATA_STREAM_FAILURE_STORE_SETTINGS

    • SUPPORTED_USER_SETTINGS

      public static final Set<String> SUPPORTED_USER_SETTINGS

    • SUPPORTED_USER_SETTINGS_PREFIXES

      public static final Set<String> SUPPORTED_USER_SETTINGS_PREFIXES

    • DATA_STREAM_FAILURE_STORE_MAPPING

      public static final CompressedXContent DATA_STREAM_FAILURE_STORE_MAPPING

    • FAILURE_STORE_DEFINITION_VERSION

      public static final int FAILURE_STORE_DEFINITION_VERSION
      See Also:

    • FAILURE_STORE_DEFINITION_VERSION_SETTING

      public static final Setting<Integer> FAILURE_STORE_DEFINITION_VERSION_SETTING

  • Constructor Details

    • DataStreamFailureStoreDefinition

      public DataStreamFailureStoreDefinition()

  • Method Details

    • getFailureStoreRefreshInterval

      public static TimeValue getFailureStoreRefreshInterval(Settings settings)

    • buildFailureStoreIndexSettings

      public static Settings buildFailureStoreIndexSettings(Settings nodeSettings)
      Obtains the default settings to be used when creating a failure store index on a data stream.
      Parameters:
      nodeSettings - settings from the cluster service which capture the node's current settings
      Returns:
      either the existing settings if no changes are needed, or a new settings instance which includes failure store specific settings

    • applyFailureStoreSettings

      public static Settings.Builder applyFailureStoreSettings(Settings nodeSettings, Settings.Builder builder)
      Modifies an existing index's settings so that it can be added to a data stream's failure store.
      Parameters:
      nodeSettings - settings from the cluster service which capture the node's current settings
      builder - to capture failure store specific index settings
      Returns:
      the original settings builder, with any failure store specific settings applied

    • filterUserDefinedSettings

      public static Settings.Builder filterUserDefinedSettings(Settings.Builder builder)
      Removes the unsupported by the failure store settings from the settings provided. ATTENTION: This method should be applied BEFORE we set the necessary settings for an index
      Parameters:
      builder - the settings builder that is going to be updated
      Returns:
      the original settings builder, with the unsupported settings removed.