Class IndexSettings.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.indices.IndexSettings.Builder
- All Implemented Interfaces:
CopyableBuilder<IndexSettings.Builder,,IndexSettings> MutableBuilder<IndexSettings.Builder,,IndexSettings> ObjectBuilder<IndexSettings>
- Enclosing class:
IndexSettings
public static class IndexSettings.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndexSettings.Builder,IndexSettings>
Builder for
IndexSettings.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal IndexSettings.BuilderAPI name:analysisfinal IndexSettings.Builderanalysis(IndexSettingsAnalysis value) API name:analysisfinal IndexSettings.BuilderAPI name:analyzefinal IndexSettings.Builderanalyze(IndexSettingsAnalyze value) API name:analyzefinal IndexSettings.BuilderanalyzeMaxTokenCount(Integer value) API name:analyze.max_token_countfinal IndexSettings.BuilderautoExpandReplicas(String value) The range of replicas to maintain.final IndexSettings.BuilderAPI name:blocksfinal IndexSettings.Builderblocks(IndexSettingBlocks value) API name:blocksfinal IndexSettings.BuilderblocksMetadata(Boolean value) API name:blocks.metadatafinal IndexSettings.BuilderblocksRead(Boolean value) API name:blocks.readfinal IndexSettings.BuilderblocksReadOnly(Boolean value) API name:blocks.read_onlyfinal IndexSettings.BuilderblocksReadOnlyAllowDelete(Boolean value) API name:blocks.read_only_allow_deletefinal IndexSettings.BuilderblocksWrite(Boolean value) API name:blocks.writebuild()Builds aIndexSettings.final IndexSettings.BuilderAPI name:check_on_startupfinal IndexSettings.BuilderThe compression type for stored data.final IndexSettings.BuildercompositeIndexStarTree(Function<IndexSettingsStarTree.Builder, ObjectBuilder<IndexSettingsStarTree>> fn) API name:composite_index.star_treefinal IndexSettings.BuilderAPI name:composite_index.star_treecopy()Create a new builderCopyableBuilderthat is a copy of this one.final IndexSettings.BuildercreationDate(Long value) API name:creation_datefinal IndexSettings.BuildercreationDateString(String value) API name:creation_date_stringfinal IndexSettings.BuildercustomSettings(String key, JsonData value) Adds an entry tocustomSettings.final IndexSettings.BuildercustomSettings(Map<String, JsonData> map) Adds all elements ofmaptocustomSettings.final IndexSettings.BuilderdefaultPipeline(String value) API name:default_pipelinefinal IndexSettings.BuilderfinalPipeline(String value) API name:final_pipelinefinal IndexSettings.BuilderAPI name:formatfinal IndexSettings.BuilderAPI name:gc_deletesfinal IndexSettings.BuilderAPI name:gc_deletesfinal IndexSettings.BuilderAPI name:hiddenfinal IndexSettings.BuilderAPI name:highlightfinal IndexSettings.Builderhighlight(IndexSettingsHighlight value) API name:highlightfinal IndexSettings.BuilderAPI name:highlight.max_analyzed_offsetfinal IndexSettings.BuilderAPI name:indexfinal IndexSettings.Builderindex(IndexSettings value) API name:indexfinal IndexSettings.BuilderAPI name:indexingfinal IndexSettings.Builderindexing(IndexSettingsIndexing value) API name:indexingfinal IndexSettings.BuilderAPI name:indexing_pressurefinal IndexSettings.BuilderindexingPressure(IndexingPressure value) API name:indexing_pressurefinal IndexSettings.BuilderAPI name:knnfinal IndexSettings.BuilderknnAlgoParamEfSearch(Integer value) API name:knn.algo_param.ef_searchfinal IndexSettings.BuilderAPI name:lifecyclefinal IndexSettings.Builderlifecycle(IndexSettingsLifecycle value) API name:lifecyclefinal IndexSettings.BuilderlifecycleName(String value) API name:lifecycle.namefinal IndexSettings.BuilderAPI name:load_fixed_bitset_filters_eagerlyfinal IndexSettings.BuilderAPI name:mappingfinal IndexSettings.Buildermapping(IndexSettingsMapping value) API name:mappingfinal IndexSettings.BuildermaxDocvalueFieldsSearch(Integer value) API name:max_docvalue_fields_searchfinal IndexSettings.BuildermaxInnerResultWindow(Integer value) API name:max_inner_result_windowfinal IndexSettings.BuildermaxNgramDiff(Integer value) API name:max_ngram_difffinal IndexSettings.BuildermaxRefreshListeners(Integer value) API name:max_refresh_listenersfinal IndexSettings.BuildermaxRegexLength(Integer value) API name:max_regex_lengthfinal IndexSettings.BuildermaxRescoreWindow(Integer value) API name:max_rescore_windowfinal IndexSettings.BuildermaxResultWindow(Integer value) API name:max_result_windowfinal IndexSettings.BuildermaxScriptFields(Integer value) API name:max_script_fieldsfinal IndexSettings.BuildermaxShingleDiff(Integer value) API name:max_shingle_difffinal IndexSettings.BuildermaxSlicesPerScroll(Integer value) API name:max_slices_per_scrollfinal IndexSettings.BuildermaxTermsCount(Integer value) API name:max_terms_countfinal IndexSettings.BuilderAPI name:mergefinal IndexSettings.Buildermerge(IndexSettingsMerge value) API name:mergefinal IndexSettings.BuilderAPI name:merge.scheduler.max_thread_countfinal IndexSettings.BuilderAPI name:modefinal IndexSettings.BuildernumberOfReplicas(Integer value) API name:number_of_replicasfinal IndexSettings.BuildernumberOfRoutingShards(Integer value) API name:number_of_routing_shardsfinal IndexSettings.BuildernumberOfShards(Integer value) API name:number_of_shardsfinal IndexSettings.BuilderAPI name:priorityfinal IndexSettings.BuilderprovidedName(String value) API name:provided_namefinal IndexSettings.BuilderAPI name:queriesfinal IndexSettings.Builderqueries(IndexSettingsQueries value) API name:queriesfinal IndexSettings.BuilderAPI name:query_stringfinal IndexSettings.BuilderAPI name:query_stringfinal IndexSettings.BuilderqueryStringLenient(Boolean value) API name:query_string.lenientfinal IndexSettings.BuilderAPI name:refresh_intervalfinal IndexSettings.BuilderrefreshInterval(Time value) API name:refresh_intervalfinal IndexSettings.BuilderAPI name:routingfinal IndexSettings.Builderrouting(IndexRouting value) API name:routingfinal IndexSettings.BuilderroutingPartitionSize(Integer value) API name:routing_partition_sizefinal IndexSettings.BuilderroutingPath(String value, String... values) API name:routing_pathfinal IndexSettings.BuilderroutingPath(List<String> list) API name:routing_pathfinal IndexSettings.BuilderAPI name:searchfinal IndexSettings.Buildersearch(IndexSettingsSearch value) API name:searchfinal IndexSettings.BuilderAPI name:search.idle.afterfinal IndexSettings.BuildersearchIdleAfter(Time value) API name:search.idle.afterfinal IndexSettings.BuilderAPI name:settingsfinal IndexSettings.Buildersettings(IndexSettings value) API name:settingsfinal IndexSettings.BuilderAPI name:similarityfinal IndexSettings.BuilderAPI name:similarityfinal IndexSettings.BuilderAPI name:soft_deletesfinal IndexSettings.BuildersoftDeletes(SoftDeletes value) API name:soft_deletesfinal IndexSettings.BuilderAPI name:soft_deletes.retention_lease.periodfinal IndexSettings.BuilderAPI name:soft_deletes.retention_lease.periodfinal IndexSettings.BuilderAPI name:sortfinal IndexSettings.Buildersort(IndexSegmentSort value) API name:sortfinal IndexSettings.BuilderAPI name:storefinal IndexSettings.Builderstore(IndexSettingsStore value) API name:storefinal IndexSettings.BuildertopMetricsMaxSize(Integer value) API name:top_metrics_max_sizefinal IndexSettings.BuilderAPI name:translogfinal IndexSettings.BuilderAPI name:translogfinal IndexSettings.BuilderAPI name:translog.durabilityfinal IndexSettings.BuildertranslogFlushThresholdSize(String value) API name:translog.flush_threshold_sizefinal IndexSettings.BuilderAPI name:uuidfinal IndexSettings.BuilderverifiedBeforeClose(Boolean value) API name:verified_before_closefinal IndexSettings.BuilderAPI name:versionfinal IndexSettings.Builderversion(IndexVersioning value) API name:versionMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<IndexSettings.Builder,IndexSettings> - Returns:
- a new builder instance.
-
analysis
API name:analysis -
analysis
@Nonnull public final IndexSettings.Builder analysis(Function<IndexSettingsAnalysis.Builder, ObjectBuilder<IndexSettingsAnalysis>> fn) API name:analysis -
analyze
API name:analyze -
analyze
@Nonnull public final IndexSettings.Builder analyze(Function<IndexSettingsAnalyze.Builder, ObjectBuilder<IndexSettingsAnalyze>> fn) API name:analyze -
analyzeMaxTokenCount
API name:analyze.max_token_count -
autoExpandReplicas
The range of replicas to maintain.API name:
auto_expand_replicas -
blocks
API name:blocks -
blocks
@Nonnull public final IndexSettings.Builder blocks(Function<IndexSettingBlocks.Builder, ObjectBuilder<IndexSettingBlocks>> fn) API name:blocks -
blocksMetadata
API name:blocks.metadata -
blocksRead
API name:blocks.read -
blocksReadOnly
API name:blocks.read_only -
blocksReadOnlyAllowDelete
API name:blocks.read_only_allow_delete -
blocksWrite
API name:blocks.write -
checkOnStartup
API name:check_on_startup -
codec
The compression type for stored data.API name:
codec -
compositeIndexStarTree
@Nonnull public final IndexSettings.Builder compositeIndexStarTree(@Nullable IndexSettingsStarTree value) API name:composite_index.star_tree -
compositeIndexStarTree
@Nonnull public final IndexSettings.Builder compositeIndexStarTree(Function<IndexSettingsStarTree.Builder, ObjectBuilder<IndexSettingsStarTree>> fn) API name:composite_index.star_tree -
creationDate
API name:creation_date -
creationDateString
API name:creation_date_string -
customSettings
Adds all elements of
maptocustomSettings. -
customSettings
Adds an entry to
customSettings. -
defaultPipeline
API name:default_pipeline -
finalPipeline
API name:final_pipeline -
format
API name:format -
gcDeletes
API name:gc_deletes -
gcDeletes
@Nonnull public final IndexSettings.Builder gcDeletes(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:gc_deletes -
highlight
API name:highlight -
highlight
@Nonnull public final IndexSettings.Builder highlight(Function<IndexSettingsHighlight.Builder, ObjectBuilder<IndexSettingsHighlight>> fn) API name:highlight -
highlightMaxAnalyzedOffset
API name:highlight.max_analyzed_offset -
index
API name:index -
index
@Nonnull public final IndexSettings.Builder index(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) API name:index -
indexing
API name:indexing -
indexing
@Nonnull public final IndexSettings.Builder indexing(Function<IndexSettingsIndexing.Builder, ObjectBuilder<IndexSettingsIndexing>> fn) API name:indexing -
indexingPressure
API name:indexing_pressure -
indexingPressure
@Nonnull public final IndexSettings.Builder indexingPressure(Function<IndexingPressure.Builder, ObjectBuilder<IndexingPressure>> fn) API name:indexing_pressure -
knn
API name:knn -
knnAlgoParamEfSearch
API name:knn.algo_param.ef_search -
lifecycle
API name:lifecycle -
lifecycle
@Nonnull public final IndexSettings.Builder lifecycle(Function<IndexSettingsLifecycle.Builder, ObjectBuilder<IndexSettingsLifecycle>> fn) API name:lifecycle -
lifecycleName
API name:lifecycle.name -
loadFixedBitsetFiltersEagerly
API name:load_fixed_bitset_filters_eagerly -
mapping
API name:mapping -
mapping
@Nonnull public final IndexSettings.Builder mapping(Function<IndexSettingsMapping.Builder, ObjectBuilder<IndexSettingsMapping>> fn) API name:mapping -
maxDocvalueFieldsSearch
API name:max_docvalue_fields_search -
maxInnerResultWindow
API name:max_inner_result_window -
maxNgramDiff
API name:max_ngram_diff -
maxRefreshListeners
API name:max_refresh_listeners -
maxRegexLength
API name:max_regex_length -
maxRescoreWindow
API name:max_rescore_window -
maxResultWindow
API name:max_result_window -
maxScriptFields
API name:max_script_fields -
maxShingleDiff
API name:max_shingle_diff -
maxSlicesPerScroll
API name:max_slices_per_scroll -
maxTermsCount
API name:max_terms_count -
merge
API name:merge -
merge
@Nonnull public final IndexSettings.Builder merge(Function<IndexSettingsMerge.Builder, ObjectBuilder<IndexSettingsMerge>> fn) API name:merge -
mergeSchedulerMaxThreadCount
API name:merge.scheduler.max_thread_count -
mode
API name:mode -
numberOfReplicas
API name:number_of_replicas -
numberOfRoutingShards
API name:number_of_routing_shards -
numberOfShards
API name:number_of_shards -
priority
API name:priority -
providedName
API name:provided_name -
queries
API name:queries -
queries
@Nonnull public final IndexSettings.Builder queries(Function<IndexSettingsQueries.Builder, ObjectBuilder<IndexSettingsQueries>> fn) API name:queries -
queryString
API name:query_string -
queryString
@Nonnull public final IndexSettings.Builder queryString(Function<IndexSettingsQueryString.Builder, ObjectBuilder<IndexSettingsQueryString>> fn) API name:query_string -
queryStringLenient
API name:query_string.lenient -
refreshInterval
API name:refresh_interval -
refreshInterval
@Nonnull public final IndexSettings.Builder refreshInterval(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:refresh_interval -
routing
API name:routing -
routing
@Nonnull public final IndexSettings.Builder routing(Function<IndexRouting.Builder, ObjectBuilder<IndexRouting>> fn) API name:routing -
routingPartitionSize
API name:routing_partition_size -
routingPath
API name:routing_pathAdds all elements of
listtoroutingPath. -
routingPath
API name:routing_pathAdds one or more values to
routingPath. -
search
API name:search -
search
@Nonnull public final IndexSettings.Builder search(Function<IndexSettingsSearch.Builder, ObjectBuilder<IndexSettingsSearch>> fn) API name:search -
searchIdleAfter
API name:search.idle.after -
searchIdleAfter
@Nonnull public final IndexSettings.Builder searchIdleAfter(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:search.idle.after -
settings
API name:settings -
settings
@Nonnull public final IndexSettings.Builder settings(Function<IndexSettings.Builder, ObjectBuilder<IndexSettings>> fn) API name:settings -
similarity
API name:similarity -
similarity
@Nonnull public final IndexSettings.Builder similarity(Function<IndexSettingsSimilarity.Builder, ObjectBuilder<IndexSettingsSimilarity>> fn) API name:similarity -
softDeletes
API name:soft_deletes -
softDeletes
@Nonnull public final IndexSettings.Builder softDeletes(Function<SoftDeletes.Builder, ObjectBuilder<SoftDeletes>> fn) API name:soft_deletes -
softDeletesRetentionLeasePeriod
API name:soft_deletes.retention_lease.period -
softDeletesRetentionLeasePeriod
@Nonnull public final IndexSettings.Builder softDeletesRetentionLeasePeriod(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:soft_deletes.retention_lease.period -
sort
API name:sort -
sort
@Nonnull public final IndexSettings.Builder sort(Function<IndexSegmentSort.Builder, ObjectBuilder<IndexSegmentSort>> fn) API name:sort -
store
API name:store -
store
@Nonnull public final IndexSettings.Builder store(Function<IndexSettingsStore.Builder, ObjectBuilder<IndexSettingsStore>> fn) API name:store -
topMetricsMaxSize
API name:top_metrics_max_size -
translog
API name:translog -
translog
@Nonnull public final IndexSettings.Builder translog(Function<Translog.Builder, ObjectBuilder<Translog>> fn) API name:translog -
translogDurability
API name:translog.durability -
translogFlushThresholdSize
API name:translog.flush_threshold_size -
uuid
API name:uuid -
verifiedBeforeClose
API name:verified_before_close -
version
API name:version -
version
@Nonnull public final IndexSettings.Builder version(Function<IndexVersioning.Builder, ObjectBuilder<IndexVersioning>> fn) API name:version -
build
Builds aIndexSettings.- Specified by:
buildin interfaceObjectBuilder<IndexSettings>- Throws:
NullPointerException- if some of the required fields are null.
-