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

API name: index

mode

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

API name: mode

routingPath

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

API name: routing_path

Adds all elements of list to routingPath.

routingPath

public final IndexSettings.Builder routingPath(java.lang.String value,
java.lang.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(java.util.function.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(java.util.function.Function<IndexSegmentSort.Builder,ObjectBuilder<IndexSegmentSort>> fn)

API name: sort

numberOfShards

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

API name: number_of_shards

numberOfReplicas

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

API name: number_of_replicas

numberOfRoutingShards

public final IndexSettings.Builder numberOfRoutingShards(@Nullable
java.lang.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
java.lang.String value)

API name: codec

routingPartitionSize

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

API name: routing_partition_size

loadFixedBitsetFiltersEagerly

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

API name: load_fixed_bitset_filters_eagerly

hidden

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

API name: hidden

autoExpandReplicas

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

API name: auto_expand_replicas

merge

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

API name: merge

merge

public final IndexSettings.Builder merge(java.util.function.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(java.util.function.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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: refresh_interval

maxResultWindow

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

API name: max_result_window

maxInnerResultWindow

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

API name: max_inner_result_window

maxRescoreWindow

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

API name: max_rescore_window

maxDocvalueFieldsSearch

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

API name: max_docvalue_fields_search

maxScriptFields

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

API name: max_script_fields

maxNgramDiff

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

API name: max_ngram_diff

maxShingleDiff

public final IndexSettings.Builder maxShingleDiff(@Nullable
java.lang.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(java.util.function.Function<IndexSettingBlocks.Builder,ObjectBuilder<IndexSettingBlocks>> fn)

API name: blocks

maxRefreshListeners

public final IndexSettings.Builder maxRefreshListeners(@Nullable
java.lang.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.

API name: analyze

analyze

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

Settings to define analyzers, tokenizers, token filters and character filters.

API name: analyze

highlight

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

API name: highlight

highlight

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

API name: highlight

maxTermsCount

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

API name: max_terms_count

maxRegexLength

public final IndexSettings.Builder maxRegexLength(@Nullable
java.lang.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(java.util.function.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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: gc_deletes

defaultPipeline

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

API name: default_pipeline

finalPipeline

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

API name: final_pipeline

lifecycle

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

API name: lifecycle

lifecycle

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

API name: lifecycle

providedName

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

API name: provided_name

creationDate

public final IndexSettings.Builder creationDate(@Nullable
java.lang.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
java.lang.String value)

API name: uuid

version

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

API name: version

version

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

API name: version

verifiedBeforeClose

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

API name: verified_before_close

format

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

API name: format

maxSlicesPerScroll

public final IndexSettings.Builder maxSlicesPerScroll(@Nullable
java.lang.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(java.util.function.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(java.util.function.Function<SettingsQueryString.Builder,ObjectBuilder<SettingsQueryString>> fn)

API name: query_string

priority

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

API name: priority

topMetricsMaxSize

public final IndexSettings.Builder topMetricsMaxSize(@Nullable
java.lang.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(java.util.function.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(java.util.function.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(java.util.function.Function<IndexSettingsTimeSeries.Builder,ObjectBuilder<IndexSettingsTimeSeries>> fn)

API name: time_series

shards

public final IndexSettings.Builder shards(@Nullable
java.lang.Integer value)

API name: shards

queries

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

API name: queries

queries

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

API name: queries

similarity

public final IndexSettings.Builder similarity(@Nullable
SettingsSimilarity value)

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

API name: similarity

similarity

public final IndexSettings.Builder similarity(java.util.function.Function<SettingsSimilarity.Builder,ObjectBuilder<SettingsSimilarity>> fn)

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

API name: similarity

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(java.util.function.Function<MappingLimitSettings.Builder,ObjectBuilder<MappingLimitSettings>> fn)

Enable or disable dynamic mapping for an index.

API name: mapping

indexingSlowlog

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

API name: indexing.slowlog

indexingSlowlog

public final IndexSettings.Builder indexingSlowlog(java.util.function.Function<SlowlogSettings.Builder,ObjectBuilder<SlowlogSettings>> 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(java.util.function.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(java.util.function.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:

java.lang.NullPointerException - if some of the required fields are null.