Package co.elastic.clients.elasticsearch.indices

Class IndexSettings

java.lang.Object
co.elastic.clients.elasticsearch.indices.IndexSettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IndexSettings extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static IndexSettings of(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

    • otherSettings

      public final Map<String,JsonData> otherSettings()
      Additional settings not covered in this type. Unless these settings are defined by a plugin, please open an issue on the Elasticsearch API specification so that they can be added in a future release.

    • index

      @Nullable public final IndexSettings index()
      API name: index

    • mode

      @Nullable public final String mode()
      API name: mode

    • routingPath

      public final List<String> routingPath()
      API name: routing_path

    • softDeletes

      @Nullable public final SoftDeletes softDeletes()
      API name: soft_deletes

    • sort

      @Nullable public final IndexSegmentSort sort()
      API name: sort

    • numberOfShards

      @Nullable public final String numberOfShards()
      API name: number_of_shards

    • numberOfReplicas

      @Nullable public final String numberOfReplicas()
      API name: number_of_replicas

    • numberOfRoutingShards

      @Nullable public final Integer numberOfRoutingShards()
      API name: number_of_routing_shards

    • checkOnStartup

      @Nullable public final IndexCheckOnStartup checkOnStartup()
      API name: check_on_startup

    • codec

      @Nullable public final String codec()
      API name: codec

    • routingPartitionSize

      @Nullable public final Integer routingPartitionSize()
      API name: routing_partition_size

    • loadFixedBitsetFiltersEagerly

      @Nullable public final Boolean loadFixedBitsetFiltersEagerly()
      API name: load_fixed_bitset_filters_eagerly

    • hidden

      @Nullable public final Boolean hidden()
      API name: hidden

    • autoExpandReplicas

      @Nullable public final String autoExpandReplicas()
      API name: auto_expand_replicas

    • merge

      @Nullable public final Merge merge()
      API name: merge

    • search

      @Nullable public final SettingsSearch search()
      API name: search

    • refreshInterval

      @Nullable public final Time refreshInterval()
      API name: refresh_interval

    • maxResultWindow

      @Nullable public final Integer maxResultWindow()
      API name: max_result_window

    • maxInnerResultWindow

      @Nullable public final Integer maxInnerResultWindow()
      API name: max_inner_result_window

    • maxRescoreWindow

      @Nullable public final Integer maxRescoreWindow()
      API name: max_rescore_window

    • maxDocvalueFieldsSearch

      @Nullable public final Integer maxDocvalueFieldsSearch()
      API name: max_docvalue_fields_search

    • maxScriptFields

      @Nullable public final Integer maxScriptFields()
      API name: max_script_fields

    • maxNgramDiff

      @Nullable public final Integer maxNgramDiff()
      API name: max_ngram_diff

    • maxShingleDiff

      @Nullable public final Integer maxShingleDiff()
      API name: max_shingle_diff

    • blocks

      @Nullable public final IndexSettingBlocks blocks()
      API name: blocks

    • maxRefreshListeners

      @Nullable public final Integer maxRefreshListeners()
      API name: max_refresh_listeners

    • analyze

      @Nullable public final SettingsAnalyze analyze()
      Settings to define analyzers, tokenizers, token filters and character filters. Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.

      API name: analyze

    • highlight

      @Nullable public final SettingsHighlight highlight()
      API name: highlight

    • maxTermsCount

      @Nullable public final Integer maxTermsCount()
      API name: max_terms_count

    • maxRegexLength

      @Nullable public final Integer maxRegexLength()
      API name: max_regex_length

    • routing

      @Nullable public final IndexRouting routing()
      API name: routing

    • gcDeletes

      @Nullable public final Time gcDeletes()
      API name: gc_deletes

    • defaultPipeline

      @Nullable public final String defaultPipeline()
      API name: default_pipeline

    • finalPipeline

      @Nullable public final String finalPipeline()
      API name: final_pipeline

    • lifecycle

      @Nullable public final IndexSettingsLifecycle lifecycle()
      API name: lifecycle

    • providedName

      @Nullable public final String providedName()
      API name: provided_name

    • creationDate

      @Nullable public final Long creationDate()
      API name: creation_date

    • creationDateString

      @Nullable public final DateTime creationDateString()
      API name: creation_date_string

    • uuid

      @Nullable public final String uuid()
      API name: uuid

    • version

      @Nullable public final IndexVersioning version()
      API name: version

    • verifiedBeforeClose

      @Nullable public final Boolean verifiedBeforeClose()
      API name: verified_before_close

    • format

      @Nullable public final String format()
      API name: format

    • maxSlicesPerScroll

      @Nullable public final Integer maxSlicesPerScroll()
      API name: max_slices_per_scroll

    • translog

      @Nullable public final Translog translog()
      API name: translog

    • queryString

      @Nullable public final SettingsQueryString queryString()
      API name: query_string

    • priority

      @Nullable public final String priority()
      API name: priority

    • topMetricsMaxSize

      @Nullable public final Integer topMetricsMaxSize()
      API name: top_metrics_max_size

    • analysis

      @Nullable public final IndexSettingsAnalysis analysis()
      API name: analysis

    • settings

      @Nullable public final IndexSettings settings()
      API name: settings

    • timeSeries

      @Nullable public final IndexSettingsTimeSeries timeSeries()
      API name: time_series

    • queries

      @Nullable public final Queries queries()
      API name: queries

    • similarity

      public final Map<String,SettingsSimilarity> similarity()
      Configure custom similarity settings to customize how search results are scored.

      API name: similarity

    • mapping

      @Nullable public final MappingLimitSettings mapping()
      Enable or disable dynamic mapping for an index.

      API name: mapping

    • indexingSlowlog

      @Nullable public final IndexingSlowlogSettings indexingSlowlog()
      API name: indexing.slowlog

    • indexingPressure

      @Nullable public final IndexingPressure indexingPressure()
      Configure indexing back pressure limits.

      API name: indexing_pressure

    • store

      @Nullable public final Storage store()
      The store module allows you to control how index data is stored and accessed on disk.

      API name: store

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupIndexSettingsDeserializer

      protected static void setupIndexSettingsDeserializer(ObjectDeserializer<IndexSettings.Builder> op)