java.lang.Object
org.elasticsearch.cluster.metadata.Metadata
All Implemented Interfaces:
Diffable<Metadata>, Writeable, ChunkedToXContent

public class Metadata extends Object implements Diffable<Metadata>, ChunkedToXContent
Metadata is the part of the ClusterState which persists across restarts. This persistence is XContent-based, so a round-trip through XContent must be faithful in Metadata.XContentContext.GATEWAY context.

The details of how this is persisted are covered in PersistedClusterStateService.

  • Field Details

    • ON_NEXT_INDEX_FIND_MAPPINGS_NOOP

      public static final Runnable ON_NEXT_INDEX_FIND_MAPPINGS_NOOP
    • ALL

      public static final String ALL
      See Also:
    • UNKNOWN_CLUSTER_UUID

      public static final String UNKNOWN_CLUSTER_UUID
      See Also:
    • DEFAULT_PROJECT_ID

      public static final ProjectId DEFAULT_PROJECT_ID
    • API_ONLY

      public static final EnumSet<Metadata.XContentContext> API_ONLY
      Indicates that this custom metadata will be returned as part of an API call but will not be persisted
    • API_AND_GATEWAY

      public static final EnumSet<Metadata.XContentContext> API_AND_GATEWAY
      Indicates that this custom metadata will be returned as part of an API call and will be persisted between node restarts, but will not be a part of a snapshot global state
    • API_AND_SNAPSHOT

      public static final EnumSet<Metadata.XContentContext> API_AND_SNAPSHOT
      Indicates that this custom metadata will be returned as part of an API call and stored as a part of a snapshot global state, but will not be persisted between node restarts
    • ALL_CONTEXTS

      public static final EnumSet<Metadata.XContentContext> ALL_CONTEXTS
      Indicates that this custom metadata will be returned as part of an API call, stored as a part of a snapshot global state, and will be persisted between node restarts
    • SETTING_READ_ONLY_SETTING

      public static final Setting<Boolean> SETTING_READ_ONLY_SETTING
    • CLUSTER_READ_ONLY_BLOCK

      public static final ClusterBlock CLUSTER_READ_ONLY_BLOCK
    • SETTING_READ_ONLY_ALLOW_DELETE_SETTING

      public static final Setting<Boolean> SETTING_READ_ONLY_ALLOW_DELETE_SETTING
    • CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK

      public static final ClusterBlock CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK
    • EMPTY_METADATA

      public static final Metadata EMPTY_METADATA
    • CONTEXT_MODE_PARAM

      public static final String CONTEXT_MODE_PARAM
      See Also:
    • CONTEXT_MODE_SNAPSHOT

      public static final String CONTEXT_MODE_SNAPSHOT
    • CONTEXT_MODE_GATEWAY

      public static final String CONTEXT_MODE_GATEWAY
    • CONTEXT_MODE_API

      public static final String CONTEXT_MODE_API
    • DEDUPLICATED_MAPPINGS_PARAM

      public static final String DEDUPLICATED_MAPPINGS_PARAM
      See Also:
    • GLOBAL_STATE_FILE_PREFIX

      public static final String GLOBAL_STATE_FILE_PREFIX
      See Also:
  • Method Details