|
@@ -1,142 +0,0 @@
|
|
|
-[[java-rest-high-indices-put-settings]]
|
|
|
-=== Update Indices Settings API
|
|
|
-
|
|
|
-The Update Indices Settings API allows to change specific index level settings.
|
|
|
-
|
|
|
-[[java-rest-high-indices-put-settings-request]]
|
|
|
-==== Update Indices Settings Request
|
|
|
-
|
|
|
-An `UpdateSettingsRequest`:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request]
|
|
|
---------------------------------------------------
|
|
|
-<1> Update settings for one index
|
|
|
-<2> Update settings for multiple indices
|
|
|
-<3> Update settings for all indices
|
|
|
-
|
|
|
-==== Indices Settings
|
|
|
-At least one setting to be updated must be provided:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-create-settings]
|
|
|
---------------------------------------------------
|
|
|
-<1> Sets the index settings to be applied
|
|
|
-
|
|
|
-==== Providing the Settings
|
|
|
-The settings to be applied can be provided in different ways:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-create-settings]
|
|
|
---------------------------------------------------
|
|
|
-<1> Creates a setting as `Settings`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-settings-builder]
|
|
|
---------------------------------------------------
|
|
|
-<1> Settings provided as `Settings.Builder`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-settings-source]
|
|
|
---------------------------------------------------
|
|
|
-<1> Settings provided as `String`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-settings-map]
|
|
|
---------------------------------------------------
|
|
|
-<1> Settings provided as a `Map`
|
|
|
-
|
|
|
-==== Optional Arguments
|
|
|
-The following arguments can optionally be provided:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request-flat-settings]
|
|
|
---------------------------------------------------
|
|
|
-<1> Whether the updated settings returned in the `UpdateSettings` should
|
|
|
-be in a flat format
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request-preserveExisting]
|
|
|
---------------------------------------------------
|
|
|
-<1> Whether to update existing settings. If set to `true` existing settings
|
|
|
-on an index remain unchanged, the default is `false`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request-timeout]
|
|
|
---------------------------------------------------
|
|
|
-<1> Timeout to wait for the all the nodes to acknowledge the new setting
|
|
|
-as a `TimeValue`
|
|
|
-<2> Timeout to wait for the all the nodes to acknowledge the new setting
|
|
|
-as a `String`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request-masterTimeout]
|
|
|
---------------------------------------------------
|
|
|
-<1> Timeout to connect to the master node as a `TimeValue`
|
|
|
-<2> Timeout to connect to the master node as a `String`
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-request-indicesOptions]
|
|
|
---------------------------------------------------
|
|
|
-<1> Setting `IndicesOptions` controls how unavailable indices are resolved and
|
|
|
-how wildcard expressions are expanded
|
|
|
-
|
|
|
-[[java-rest-high-indices-put-settings-sync]]
|
|
|
-==== Synchronous Execution
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-execute]
|
|
|
---------------------------------------------------
|
|
|
-
|
|
|
-[[java-rest-high-indices-put-settings-async]]
|
|
|
-==== Asynchronous Execution
|
|
|
-
|
|
|
-The asynchronous execution of an indices update settings requires both the
|
|
|
-`UpdateSettingsRequest` instance and an `ActionListener` instance to be
|
|
|
-passed to the asynchronous method:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-execute-async]
|
|
|
---------------------------------------------------
|
|
|
-<1> The `UpdateSettingsRequest` to execute and the `ActionListener`
|
|
|
-to use when the execution completes
|
|
|
-
|
|
|
-The asynchronous method does not block and returns immediately. Once it is
|
|
|
-completed the `ActionListener` is called back using the `onResponse` method
|
|
|
-if the execution successfully completed or using the `onFailure` method if
|
|
|
-it failed.
|
|
|
-
|
|
|
-A typical listener for `UpdateSettingsResponse` looks like:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-execute-listener]
|
|
|
---------------------------------------------------
|
|
|
-<1> Called when the execution is successfully completed. The response is
|
|
|
-provided as an argument
|
|
|
-<2> Called in case of a failure. The raised exception is provided as an argument
|
|
|
-
|
|
|
-[[java-rest-high-indices-put-settings-response]]
|
|
|
-==== Update Indices Settings Response
|
|
|
-
|
|
|
-The returned `UpdateSettingsResponse` allows to retrieve information about the
|
|
|
-executed operation as follows:
|
|
|
-
|
|
|
-["source","java",subs="attributes,callouts,macros"]
|
|
|
---------------------------------------------------
|
|
|
-include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[put-settings-response]
|
|
|
---------------------------------------------------
|
|
|
-<1> Indicates whether all of the nodes have acknowledged the request
|