Package co.elastic.clients.elasticsearch.indices

Class IndexSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<IndexSettings.Builder>

co.elastic.clients.elasticsearch.indices.IndexSettings.Builder

All Implemented Interfaces:

WithJson<IndexSettings.Builder>, ObjectBuilder<IndexSettings>

Enclosing class:

IndexSettings

public static class IndexSettings.Builder
extends WithJsonObjectBuilderBase<IndexSettings.Builder>
implements ObjectBuilder<IndexSettings>

Builder for IndexSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexSettings.Builder	analysis(IndexSettingsAnalysis value)	API name: analysis
final IndexSettings.Builder	analysis(Function<IndexSettingsAnalysis.Builder,ObjectBuilder<IndexSettingsAnalysis>> fn)	API name: analysis
final IndexSettings.Builder	analyze(SettingsAnalyze value)	Settings to define analyzers, tokenizers, token filters and character filters.
final IndexSettings.Builder	analyze(Function<SettingsAnalyze.Builder,ObjectBuilder<SettingsAnalyze>> fn)	Settings to define analyzers, tokenizers, token filters and character filters.
final IndexSettings.Builder	autoExpandReplicas(String value)	API name: auto_expand_replicas
final IndexSettings.Builder	autoExpandReplicasWithNull()	API name: auto_expand_replicas
final IndexSettings.Builder	blocks(IndexSettingBlocks value)	API name: blocks
final IndexSettings.Builder	blocks(Function<IndexSettingBlocks.Builder,ObjectBuilder<IndexSettingBlocks>> fn)	API name: blocks
IndexSettings	build()	Builds a IndexSettings.
final IndexSettings.Builder	checkOnStartup(IndexCheckOnStartup value)	API name: check_on_startup
final IndexSettings.Builder	codec(String value)	API name: codec
final IndexSettings.Builder	creationDate(Long value)	API name: creation_date
final IndexSettings.Builder	creationDateString(DateTime value)	API name: creation_date_string
final IndexSettings.Builder	defaultPipeline(String value)	API name: default_pipeline
final IndexSettings.Builder	finalPipeline(String value)	API name: final_pipeline
final IndexSettings.Builder	format(String value)	API name: format
final IndexSettings.Builder	gcDeletes(Time value)	API name: gc_deletes
final IndexSettings.Builder	gcDeletes(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: gc_deletes
final IndexSettings.Builder	hidden(Boolean value)	API name: hidden
final IndexSettings.Builder	highlight(SettingsHighlight value)	API name: highlight
final IndexSettings.Builder	highlight(Function<SettingsHighlight.Builder,ObjectBuilder<SettingsHighlight>> fn)	API name: highlight
final IndexSettings.Builder	index(IndexSettings value)	API name: index
final IndexSettings.Builder	index(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: index
final IndexSettings.Builder	indexingPressure(IndexingPressure value)	Configure indexing back pressure limits.
final IndexSettings.Builder	indexingPressure(Function<IndexingPressure.Builder,ObjectBuilder<IndexingPressure>> fn)	Configure indexing back pressure limits.
final IndexSettings.Builder	indexingSlowlog(IndexingSlowlogSettings value)	API name: indexing.slowlog
final IndexSettings.Builder	indexingSlowlog(Function<IndexingSlowlogSettings.Builder,ObjectBuilder<IndexingSlowlogSettings>> fn)	API name: indexing.slowlog
final IndexSettings.Builder	lifecycle(IndexSettingsLifecycle value)	API name: lifecycle
final IndexSettings.Builder	lifecycle(Function<IndexSettingsLifecycle.Builder,ObjectBuilder<IndexSettingsLifecycle>> fn)	API name: lifecycle
final IndexSettings.Builder	loadFixedBitsetFiltersEagerly(Boolean value)	API name: load_fixed_bitset_filters_eagerly
final IndexSettings.Builder	mapping(MappingLimitSettings value)	Enable or disable dynamic mapping for an index.
final IndexSettings.Builder	mapping(Function<MappingLimitSettings.Builder,ObjectBuilder<MappingLimitSettings>> fn)	Enable or disable dynamic mapping for an index.
final IndexSettings.Builder	maxDocvalueFieldsSearch(Integer value)	API name: max_docvalue_fields_search
final IndexSettings.Builder	maxInnerResultWindow(Integer value)	API name: max_inner_result_window
final IndexSettings.Builder	maxNgramDiff(Integer value)	API name: max_ngram_diff
final IndexSettings.Builder	maxRefreshListeners(Integer value)	API name: max_refresh_listeners
final IndexSettings.Builder	maxRegexLength(Integer value)	API name: max_regex_length
final IndexSettings.Builder	maxRescoreWindow(Integer value)	API name: max_rescore_window
final IndexSettings.Builder	maxResultWindow(Integer value)	API name: max_result_window
final IndexSettings.Builder	maxScriptFields(Integer value)	API name: max_script_fields
final IndexSettings.Builder	maxShingleDiff(Integer value)	API name: max_shingle_diff
final IndexSettings.Builder	maxSlicesPerScroll(Integer value)	API name: max_slices_per_scroll
final IndexSettings.Builder	maxTermsCount(Integer value)	API name: max_terms_count
final IndexSettings.Builder	merge(Merge value)	API name: merge
final IndexSettings.Builder	merge(Function<Merge.Builder,ObjectBuilder<Merge>> fn)	API name: merge
final IndexSettings.Builder	mode(String value)	API name: mode
final IndexSettings.Builder	numberOfReplicas(String value)	API name: number_of_replicas
final IndexSettings.Builder	numberOfRoutingShards(Integer value)	API name: number_of_routing_shards
final IndexSettings.Builder	numberOfShards(String value)	API name: number_of_shards
final IndexSettings.Builder	otherSettings(String key, JsonData value)	Additional settings not covered in this type.
final IndexSettings.Builder	otherSettings(Map<String,JsonData> map)	Additional settings not covered in this type.
final IndexSettings.Builder	priority(String value)	API name: priority
final IndexSettings.Builder	providedName(String value)	API name: provided_name
final IndexSettings.Builder	queries(Queries value)	API name: queries
final IndexSettings.Builder	queries(Function<Queries.Builder,ObjectBuilder<Queries>> fn)	API name: queries
final IndexSettings.Builder	queryString(SettingsQueryString value)	API name: query_string
final IndexSettings.Builder	queryString(Function<SettingsQueryString.Builder,ObjectBuilder<SettingsQueryString>> fn)	API name: query_string
final IndexSettings.Builder	refreshInterval(Time value)	API name: refresh_interval
final IndexSettings.Builder	refreshInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: refresh_interval
final IndexSettings.Builder	routing(IndexRouting value)	API name: routing
final IndexSettings.Builder	routing(Function<IndexRouting.Builder,ObjectBuilder<IndexRouting>> fn)	API name: routing
final IndexSettings.Builder	routingPartitionSize(Integer value)	API name: routing_partition_size
final IndexSettings.Builder	routingPath(String value, String... values)	API name: routing_path
final IndexSettings.Builder	routingPath(List<String> list)	API name: routing_path
final IndexSettings.Builder	search(SettingsSearch value)	API name: search
final IndexSettings.Builder	search(Function<SettingsSearch.Builder,ObjectBuilder<SettingsSearch>> fn)	API name: search
protected IndexSettings.Builder	self()
final IndexSettings.Builder	settings(IndexSettings value)	API name: settings
final IndexSettings.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
final IndexSettings.Builder	similarity(String key, SettingsSimilarity value)	Configure custom similarity settings to customize how search results are scored.
final IndexSettings.Builder	similarity(String key, Function<SettingsSimilarity.Builder,ObjectBuilder<SettingsSimilarity>> fn)	Configure custom similarity settings to customize how search results are scored.
final IndexSettings.Builder	similarity(Map<String,SettingsSimilarity> map)	Configure custom similarity settings to customize how search results are scored.
final IndexSettings.Builder	softDeletes(SoftDeletes value)	API name: soft_deletes
final IndexSettings.Builder	softDeletes(Function<SoftDeletes.Builder,ObjectBuilder<SoftDeletes>> fn)	API name: soft_deletes
final IndexSettings.Builder	sort(IndexSegmentSort value)	API name: sort
final IndexSettings.Builder	sort(Function<IndexSegmentSort.Builder,ObjectBuilder<IndexSegmentSort>> fn)	API name: sort
final IndexSettings.Builder	store(Storage value)	The store module allows you to control how index data is stored and accessed on disk.
final IndexSettings.Builder	store(Function<Storage.Builder,ObjectBuilder<Storage>> fn)	The store module allows you to control how index data is stored and accessed on disk.
final IndexSettings.Builder	timeSeries(IndexSettingsTimeSeries value)	API name: time_series
final IndexSettings.Builder	timeSeries(Function<IndexSettingsTimeSeries.Builder,ObjectBuilder<IndexSettingsTimeSeries>> fn)	API name: time_series
final IndexSettings.Builder	topMetricsMaxSize(Integer value)	API name: top_metrics_max_size
final IndexSettings.Builder	translog(Translog value)	API name: translog
final IndexSettings.Builder	translog(Function<Translog.Builder,ObjectBuilder<Translog>> fn)	API name: translog
final IndexSettings.Builder	uuid(String value)	API name: uuid
final IndexSettings.Builder	verifiedBeforeClose(Boolean value)	API name: verified_before_close
final IndexSettings.Builder	version(IndexVersioning value)	API name: version
final IndexSettings.Builder	version(Function<IndexVersioning.Builder,ObjectBuilder<IndexVersioning>> fn)	API name: version

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

otherSettings

public final IndexSettings.Builder otherSettings(Map<String,JsonData> map)

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.

Adds all entries of map to otherSettings.

otherSettings

public final IndexSettings.Builder otherSettings(String key,
 JsonData value)

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.

Adds an entry to otherSettings.

index

public final IndexSettings.Builder index(@Nullable
 IndexSettings value)

API name: index

index

public final IndexSettings.Builder index(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: index

mode

public final IndexSettings.Builder mode(@Nullable
 String value)

API name: mode

routingPath

public final IndexSettings.Builder routingPath(List<String> list)

API name: routing_path

Adds all elements of list to routingPath.

routingPath

public final IndexSettings.Builder routingPath(String value,
 String... values)

API name: routing_path

Adds one or more values to routingPath.

softDeletes

public final IndexSettings.Builder softDeletes(@Nullable
 SoftDeletes value)

API name: soft_deletes

softDeletes

public final IndexSettings.Builder softDeletes(Function<SoftDeletes.Builder,ObjectBuilder<SoftDeletes>> fn)

API name: soft_deletes

sort

public final IndexSettings.Builder sort(@Nullable
 IndexSegmentSort value)

API name: sort

sort

public final IndexSettings.Builder sort(Function<IndexSegmentSort.Builder,ObjectBuilder<IndexSegmentSort>> fn)

API name: sort

numberOfShards

public final IndexSettings.Builder numberOfShards(@Nullable
 String value)

API name: number_of_shards

numberOfReplicas

public final IndexSettings.Builder numberOfReplicas(@Nullable
 String value)

API name: number_of_replicas

numberOfRoutingShards

public final IndexSettings.Builder numberOfRoutingShards(@Nullable
 Integer value)

API name: number_of_routing_shards

checkOnStartup

public final IndexSettings.Builder checkOnStartup(@Nullable
 IndexCheckOnStartup value)

API name: check_on_startup

codec

public final IndexSettings.Builder codec(@Nullable
 String value)

API name: codec

routingPartitionSize

public final IndexSettings.Builder routingPartitionSize(@Nullable
 Integer value)

API name: routing_partition_size

loadFixedBitsetFiltersEagerly

public final IndexSettings.Builder loadFixedBitsetFiltersEagerly(@Nullable
 Boolean value)

API name: load_fixed_bitset_filters_eagerly

hidden

public final IndexSettings.Builder hidden(@Nullable
 Boolean value)

API name: hidden

autoExpandReplicas

public final IndexSettings.Builder autoExpandReplicas(@Nullable
 String value)

API name: auto_expand_replicas

autoExpandReplicasWithNull

public final IndexSettings.Builder autoExpandReplicasWithNull()

API name: auto_expand_replicas

merge

public final IndexSettings.Builder merge(@Nullable
 Merge value)

API name: merge

merge

public final IndexSettings.Builder merge(Function<Merge.Builder,ObjectBuilder<Merge>> fn)

API name: merge

search

public final IndexSettings.Builder search(@Nullable
 SettingsSearch value)

API name: search

search

public final IndexSettings.Builder search(Function<SettingsSearch.Builder,ObjectBuilder<SettingsSearch>> fn)

API name: search

refreshInterval

public final IndexSettings.Builder refreshInterval(@Nullable
 Time value)

API name: refresh_interval

refreshInterval

public final IndexSettings.Builder refreshInterval(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: refresh_interval

maxResultWindow

public final IndexSettings.Builder maxResultWindow(@Nullable
 Integer value)

API name: max_result_window

maxInnerResultWindow

public final IndexSettings.Builder maxInnerResultWindow(@Nullable
 Integer value)

API name: max_inner_result_window

maxRescoreWindow

public final IndexSettings.Builder maxRescoreWindow(@Nullable
 Integer value)

API name: max_rescore_window

maxDocvalueFieldsSearch

public final IndexSettings.Builder maxDocvalueFieldsSearch(@Nullable
 Integer value)

API name: max_docvalue_fields_search

maxScriptFields

public final IndexSettings.Builder maxScriptFields(@Nullable
 Integer value)

API name: max_script_fields

maxNgramDiff

public final IndexSettings.Builder maxNgramDiff(@Nullable
 Integer value)

API name: max_ngram_diff

maxShingleDiff

public final IndexSettings.Builder maxShingleDiff(@Nullable
 Integer value)

API name: max_shingle_diff

blocks

public final IndexSettings.Builder blocks(@Nullable
 IndexSettingBlocks value)

API name: blocks

blocks

public final IndexSettings.Builder blocks(Function<IndexSettingBlocks.Builder,ObjectBuilder<IndexSettingBlocks>> fn)

API name: blocks

maxRefreshListeners

public final IndexSettings.Builder maxRefreshListeners(@Nullable
 Integer value)

API name: max_refresh_listeners

analyze

public final IndexSettings.Builder analyze(@Nullable
 SettingsAnalyze value)

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

analyze

public final IndexSettings.Builder analyze(Function<SettingsAnalyze.Builder,ObjectBuilder<SettingsAnalyze>> fn)

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

public final IndexSettings.Builder highlight(@Nullable
 SettingsHighlight value)

API name: highlight

highlight

public final IndexSettings.Builder highlight(Function<SettingsHighlight.Builder,ObjectBuilder<SettingsHighlight>> fn)

API name: highlight

maxTermsCount

public final IndexSettings.Builder maxTermsCount(@Nullable
 Integer value)

API name: max_terms_count

maxRegexLength

public final IndexSettings.Builder maxRegexLength(@Nullable
 Integer value)

API name: max_regex_length

routing

public final IndexSettings.Builder routing(@Nullable
 IndexRouting value)

API name: routing

routing

public final IndexSettings.Builder routing(Function<IndexRouting.Builder,ObjectBuilder<IndexRouting>> fn)

API name: routing

gcDeletes

public final IndexSettings.Builder gcDeletes(@Nullable
 Time value)

API name: gc_deletes

gcDeletes

public final IndexSettings.Builder gcDeletes(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: gc_deletes

defaultPipeline

public final IndexSettings.Builder defaultPipeline(@Nullable
 String value)

API name: default_pipeline

finalPipeline

public final IndexSettings.Builder finalPipeline(@Nullable
 String value)

API name: final_pipeline

lifecycle

public final IndexSettings.Builder lifecycle(@Nullable
 IndexSettingsLifecycle value)

API name: lifecycle

lifecycle

public final IndexSettings.Builder lifecycle(Function<IndexSettingsLifecycle.Builder,ObjectBuilder<IndexSettingsLifecycle>> fn)

API name: lifecycle

providedName

public final IndexSettings.Builder providedName(@Nullable
 String value)

API name: provided_name

creationDate

public final IndexSettings.Builder creationDate(@Nullable
 Long value)

API name: creation_date

creationDateString

public final IndexSettings.Builder creationDateString(@Nullable
 DateTime value)

API name: creation_date_string

uuid

public final IndexSettings.Builder uuid(@Nullable
 String value)

API name: uuid

version

public final IndexSettings.Builder version(@Nullable
 IndexVersioning value)

API name: version

version

public final IndexSettings.Builder version(Function<IndexVersioning.Builder,ObjectBuilder<IndexVersioning>> fn)

API name: version

verifiedBeforeClose

public final IndexSettings.Builder verifiedBeforeClose(@Nullable
 Boolean value)

API name: verified_before_close

format

public final IndexSettings.Builder format(@Nullable
 String value)

API name: format

maxSlicesPerScroll

public final IndexSettings.Builder maxSlicesPerScroll(@Nullable
 Integer value)

API name: max_slices_per_scroll

translog

public final IndexSettings.Builder translog(@Nullable
 Translog value)

API name: translog

translog

public final IndexSettings.Builder translog(Function<Translog.Builder,ObjectBuilder<Translog>> fn)

API name: translog

queryString

public final IndexSettings.Builder queryString(@Nullable
 SettingsQueryString value)

API name: query_string

queryString

public final IndexSettings.Builder queryString(Function<SettingsQueryString.Builder,ObjectBuilder<SettingsQueryString>> fn)

API name: query_string

priority

public final IndexSettings.Builder priority(@Nullable
 String value)

API name: priority

topMetricsMaxSize

public final IndexSettings.Builder topMetricsMaxSize(@Nullable
 Integer value)

API name: top_metrics_max_size

analysis

public final IndexSettings.Builder analysis(@Nullable
 IndexSettingsAnalysis value)

API name: analysis

analysis

public final IndexSettings.Builder analysis(Function<IndexSettingsAnalysis.Builder,ObjectBuilder<IndexSettingsAnalysis>> fn)

API name: analysis

settings

public final IndexSettings.Builder settings(@Nullable
 IndexSettings value)

API name: settings

settings

public final IndexSettings.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

timeSeries

public final IndexSettings.Builder timeSeries(@Nullable
 IndexSettingsTimeSeries value)

API name: time_series

timeSeries

public final IndexSettings.Builder timeSeries(Function<IndexSettingsTimeSeries.Builder,ObjectBuilder<IndexSettingsTimeSeries>> fn)

API name: time_series

queries

public final IndexSettings.Builder queries(@Nullable
 Queries value)

API name: queries

queries

public final IndexSettings.Builder queries(Function<Queries.Builder,ObjectBuilder<Queries>> fn)

API name: queries

similarity

public final IndexSettings.Builder similarity(Map<String,SettingsSimilarity> map)

Configure custom similarity settings to customize how search results are scored.

API name: similarity

Adds all entries of map to similarity.

similarity

public final IndexSettings.Builder similarity(String key,
 SettingsSimilarity value)

Configure custom similarity settings to customize how search results are scored.

API name: similarity

Adds an entry to similarity.

similarity

public final IndexSettings.Builder similarity(String key,
 Function<SettingsSimilarity.Builder,ObjectBuilder<SettingsSimilarity>> fn)

Configure custom similarity settings to customize how search results are scored.

API name: similarity

Adds an entry to similarity using a builder lambda.

mapping

public final IndexSettings.Builder mapping(@Nullable
 MappingLimitSettings value)

Enable or disable dynamic mapping for an index.

API name: mapping

mapping

public final IndexSettings.Builder mapping(Function<MappingLimitSettings.Builder,ObjectBuilder<MappingLimitSettings>> fn)

Enable or disable dynamic mapping for an index.

API name: mapping

indexingSlowlog

public final IndexSettings.Builder indexingSlowlog(@Nullable
 IndexingSlowlogSettings value)

API name: indexing.slowlog

indexingSlowlog

public final IndexSettings.Builder indexingSlowlog(Function<IndexingSlowlogSettings.Builder,ObjectBuilder<IndexingSlowlogSettings>> fn)

API name: indexing.slowlog

indexingPressure

public final IndexSettings.Builder indexingPressure(@Nullable
 IndexingPressure value)

Configure indexing back pressure limits.

API name: indexing_pressure

indexingPressure

public final IndexSettings.Builder indexingPressure(Function<IndexingPressure.Builder,ObjectBuilder<IndexingPressure>> fn)

Configure indexing back pressure limits.

API name: indexing_pressure

store

public final IndexSettings.Builder store(@Nullable
 Storage value)

The store module allows you to control how index data is stored and accessed on disk.

API name: store

store

public final IndexSettings.Builder store(Function<Storage.Builder,ObjectBuilder<Storage>> fn)

The store module allows you to control how index data is stored and accessed on disk.

API name: store

self

protected IndexSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IndexSettings.Builder>

build

public IndexSettings build()

Builds a IndexSettings.

Specified by:

build in interface ObjectBuilder<IndexSettings>

Throws:

NullPointerException - if some of the required fields are null.