Package org.opensearch.client.opensearch.indices

Class IndexSettings.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettings.Builder

All Implemented Interfaces:

ObjectBuilder<IndexSettings>

Enclosing class:

IndexSettings

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

Builder for IndexSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexSettings.Builder	analysis(java.util.function.Function<IndexSettingsAnalysis.Builder,ObjectBuilder<IndexSettingsAnalysis>> fn)	API name: analysis
IndexSettings.Builder	analysis(IndexSettingsAnalysis value)	API name: analysis
IndexSettings.Builder	analyzeMaxTokenCount(java.lang.Integer value)	API name: analyze.max_token_count
IndexSettings.Builder	autoExpandReplicas(java.lang.String value)	API name: auto_expand_replicas
IndexSettings.Builder	blocks(java.util.function.Function<IndexSettingBlocks.Builder,ObjectBuilder<IndexSettingBlocks>> fn)	API name: blocks
IndexSettings.Builder	blocks(IndexSettingBlocks value)	API name: blocks
IndexSettings.Builder	blocksMetadata(java.lang.Boolean value)	API name: blocks.metadata
IndexSettings.Builder	blocksRead(java.lang.Boolean value)	API name: blocks.read
IndexSettings.Builder	blocksReadOnly(java.lang.Boolean value)	API name: blocks.read_only
IndexSettings.Builder	blocksReadOnlyAllowDelete(java.lang.Boolean value)	API name: blocks.read_only_allow_delete
IndexSettings.Builder	blocksWrite(java.lang.Boolean value)	API name: blocks.write
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.String value)	API name: creation_date
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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: gc_deletes
IndexSettings.Builder	gcDeletes(Time value)	API name: gc_deletes
IndexSettings.Builder	hidden(java.lang.Boolean value)	API name: hidden
IndexSettings.Builder	highlightMaxAnalyzedOffset(java.lang.Integer value)	API name: highlight.max_analyzed_offset
IndexSettings.Builder	index(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: index
IndexSettings.Builder	index(IndexSettings value)	API name: index
IndexSettings.Builder	indexing(java.util.function.Function<IndexSettingsIndexing.Builder,ObjectBuilder<IndexSettingsIndexing>> fn)	API name: indexing
IndexSettings.Builder	indexing(IndexSettingsIndexing value)	API name: indexing
IndexSettings.Builder	knn(java.lang.Boolean value)	API name: knn
IndexSettings.Builder	knnAlgoParamEfSearch(java.lang.Integer value)	API name: knn.algo_param.ef_search
IndexSettings.Builder	lifecycleName(java.lang.String value)	API name: lifecycle.name
IndexSettings.Builder	loadFixedBitsetFiltersEagerly(java.lang.Boolean value)	API name: load_fixed_bitset_filters_eagerly
IndexSettings.Builder	mapping(java.util.function.Function<IndexSettingsMapping.Builder,ObjectBuilder<IndexSettingsMapping>> fn)	API name: mapping
IndexSettings.Builder	mapping(IndexSettingsMapping value)	API name: mapping
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	mergeSchedulerMaxThreadCount(java.lang.Integer value)	API name: merge.scheduler.max_thread_count
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	priority(java.lang.String value)	API name: priority
IndexSettings.Builder	providedName(java.lang.String value)	API name: provided_name
IndexSettings.Builder	queryStringLenient(java.lang.Boolean value)	API name: query_string.lenient
IndexSettings.Builder	refreshInterval(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: refresh_interval
IndexSettings.Builder	refreshInterval(Time value)	API name: refresh_interval
IndexSettings.Builder	routing(java.util.function.Function<IndexRouting.Builder,ObjectBuilder<IndexRouting>> fn)	API name: routing
IndexSettings.Builder	routing(IndexRouting value)	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(java.util.function.Function<IndexSettingsSearch.Builder,ObjectBuilder<IndexSettingsSearch>> fn)	API name: search
IndexSettings.Builder	search(IndexSettingsSearch value)	API name: search
IndexSettings.Builder	searchIdleAfter(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: search.idle.after
IndexSettings.Builder	searchIdleAfter(Time value)	API name: search.idle.after
IndexSettings.Builder	settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
IndexSettings.Builder	settings(IndexSettings value)	API name: settings
IndexSettings.Builder	softDeletes(java.util.function.Function<SoftDeletes.Builder,ObjectBuilder<SoftDeletes>> fn)	API name: soft_deletes
IndexSettings.Builder	softDeletes(SoftDeletes value)	API name: soft_deletes
IndexSettings.Builder	softDeletesRetentionLeasePeriod(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: soft_deletes.retention_lease.period
IndexSettings.Builder	softDeletesRetentionLeasePeriod(Time value)	API name: soft_deletes.retention_lease.period
IndexSettings.Builder	sort(java.util.function.Function<IndexSegmentSort.Builder,ObjectBuilder<IndexSegmentSort>> fn)	API name: sort
IndexSettings.Builder	sort(IndexSegmentSort value)	API name: sort
IndexSettings.Builder	topMetricsMaxSize(java.lang.Integer value)	API name: top_metrics_max_size
IndexSettings.Builder	translog(Translog value)	API name: translog
IndexSettings.Builder	translogDurability(java.lang.String value)	Deprecated. use IndexSettings.translog() instead
IndexSettings.Builder	translogFlushThresholdSize(java.lang.String value)	Deprecated. use IndexSettings.translog() instead
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(java.util.function.Function<IndexVersioning.Builder,ObjectBuilder<IndexVersioning>> fn)	API name: version
IndexSettings.Builder	version(IndexVersioning value)	API name: version

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

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

softDeletesRetentionLeasePeriod

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

API name: soft_deletes.retention_lease.period

softDeletesRetentionLeasePeriod

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

API name: soft_deletes.retention_lease.period

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

mergeSchedulerMaxThreadCount

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

API name: merge.scheduler.max_thread_count

searchIdleAfter

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

API name: search.idle.after

searchIdleAfter

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

API name: search.idle.after

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

blocksReadOnly

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

API name: blocks.read_only

blocksReadOnlyAllowDelete

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

API name: blocks.read_only_allow_delete

blocksRead

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

API name: blocks.read

blocksWrite

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

API name: blocks.write

blocksMetadata

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

API name: blocks.metadata

maxRefreshListeners

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

API name: max_refresh_listeners

analyzeMaxTokenCount

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

API name: analyze.max_token_count

highlightMaxAnalyzedOffset

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

API name: highlight.max_analyzed_offset

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

lifecycleName

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

API name: lifecycle.name

providedName

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

API name: provided_name

creationDate

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

API name: creation_date

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

translogDurability

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

Deprecated.

use IndexSettings.translog() instead

API name: translog.durability

translogFlushThresholdSize

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

Deprecated.

use IndexSettings.translog() instead

API name: translog.flush_threshold_size

queryStringLenient

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

API name: query_string.lenient

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

mapping

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

API name: mapping

mapping

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

API name: mapping

indexing

public final IndexSettings.Builder indexing(@Nullable
                                            IndexSettingsIndexing value)

API name: indexing

indexing

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

API name: indexing

search

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

API name: search

search

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

API name: search

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.

knn

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

API name: knn

knnAlgoParamEfSearch

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

API name: knn.algo_param.ef_search