Package org.opensearch.client.opensearch.indices

Class IndexSettings

java.lang.Object
org.opensearch.client.opensearch.indices.IndexSettings
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<IndexSettings.Builder,IndexSettings>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class IndexSettings extends Object implements PlainJsonSerializable, ToCopyableBuilder<IndexSettings.Builder,IndexSettings>
The configuration settings for an index.

  • Field Details

  • Method Details

    • of

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

    • analysis

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

    • analyze

      @Nullable public final IndexSettingsAnalyze analyze()
      API name: analyze

    • analyzeMaxTokenCount

      @Nullable public final Integer analyzeMaxTokenCount()
      API name: analyze.max_token_count

    • autoExpandReplicas

      @Nullable public final String autoExpandReplicas()
      The range of replicas to maintain.

      API name: auto_expand_replicas

    • blocks

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

    • blocksMetadata

      @Nullable public final Boolean blocksMetadata()
      API name: blocks.metadata

    • blocksRead

      @Nullable public final Boolean blocksRead()
      API name: blocks.read

    • blocksReadOnly

      @Nullable public final Boolean blocksReadOnly()
      API name: blocks.read_only

    • blocksReadOnlyAllowDelete

      @Nullable public final Boolean blocksReadOnlyAllowDelete()
      API name: blocks.read_only_allow_delete

    • blocksWrite

      @Nullable public final Boolean blocksWrite()
      API name: blocks.write

    • checkOnStartup

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

    • codec

      @Nullable public final String codec()
      The compression type for stored data.

      API name: codec

    • compositeIndexStarTree

      @Nullable public final IndexSettingsStarTree compositeIndexStarTree()
      API name: composite_index.star_tree

    • creationDate

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

    • creationDateString

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

    • customSettings

      @Nonnull public final Map<String,JsonData> customSettings()

    • defaultPipeline

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

    • finalPipeline

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

    • format

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

    • gcDeletes

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

    • hidden

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

    • highlight

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

    • highlightMaxAnalyzedOffset

      @Nullable public final Integer highlightMaxAnalyzedOffset()
      API name: highlight.max_analyzed_offset

    • index

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

    • indexing

      @Nullable public final IndexSettingsIndexing indexing()
      API name: indexing

    • indexingPressure

      @Nullable public final IndexingPressure indexingPressure()
      API name: indexing_pressure

    • knn

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

    • knnAlgoParamEfSearch

      @Nullable public final Integer knnAlgoParamEfSearch()
      API name: knn.algo_param.ef_search

    • lifecycle

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

    • lifecycleName

      @Nullable public final String lifecycleName()
      API name: lifecycle.name

    • loadFixedBitsetFiltersEagerly

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

    • mapping

      @Nullable public final IndexSettingsMapping mapping()
      API name: mapping

    • maxDocvalueFieldsSearch

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

    • maxInnerResultWindow

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

    • maxNgramDiff

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

    • maxRefreshListeners

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

    • maxRegexLength

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

    • maxRescoreWindow

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

    • maxResultWindow

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

    • maxScriptFields

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

    • maxShingleDiff

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

    • maxSlicesPerScroll

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

    • maxTermsCount

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

    • merge

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

    • mergeSchedulerMaxThreadCount

      @Nullable public final Integer mergeSchedulerMaxThreadCount()
      API name: merge.scheduler.max_thread_count

    • mode

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

    • numberOfReplicas

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

    • numberOfRoutingShards

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

    • numberOfShards

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

    • priority

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

    • providedName

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

    • queries

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

    • queryString

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

    • queryStringLenient

      @Nullable public final Boolean queryStringLenient()
      API name: query_string.lenient

    • refreshInterval

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

    • routing

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

    • routingPartitionSize

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

    • routingPath

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

    • search

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

    • searchIdleAfter

      @Nullable public final Time searchIdleAfter()
      API name: search.idle.after

    • settings

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

    • similarity

      @Nullable public final IndexSettingsSimilarity similarity()
      API name: similarity

    • softDeletes

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

    • softDeletesRetentionLeasePeriod

      @Nullable public final Time softDeletesRetentionLeasePeriod()
      API name: soft_deletes.retention_lease.period

    • sort

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

    • store

      @Nullable public final IndexSettingsStore store()
      API name: store

    • topMetricsMaxSize

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

    • translog

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

    • translogDurability

      @Nullable public final TranslogDurability translogDurability()
      API name: translog.durability

    • translogFlushThresholdSize

      @Nullable public final String translogFlushThresholdSize()
      API name: translog.flush_threshold_size

    • uuid

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

    • verifiedBeforeClose

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

    • version

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

    • 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)

    • toBuilder

      @Nonnull public IndexSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IndexSettings.Builder,IndexSettings>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static IndexSettings.Builder builder()

    • setupIndexSettingsDeserializer

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object