Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.settings.put

Class UpdateSettingsRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.master.AcknowledgedRequestBuilder<UpdateSettingsRequest,AcknowledgedResponse,UpdateSettingsRequestBuilder>

org.elasticsearch.action.admin.indices.settings.put.UpdateSettingsRequestBuilder

All Implemented Interfaces:

RequestBuilder<UpdateSettingsRequest,AcknowledgedResponse>

public class UpdateSettingsRequestBuilder
extends AcknowledgedRequestBuilder<UpdateSettingsRequest,AcknowledgedResponse,UpdateSettingsRequestBuilder>

Builder for an update index settings request

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
UpdateSettingsRequestBuilder(ElasticsearchClient client, String... indices)

Method Summary

Modifier and Type	Method	Description
UpdateSettingsRequestBuilder	origin(String origin)	Sets the origin to use, only set this when the settings update is requested by ES internal processes.
UpdateSettingsRequestBuilder	setIndices(String... indices)	Sets the indices the update settings will execute on
UpdateSettingsRequestBuilder	setIndicesOptions(IndicesOptions options)	Specifies what type of requested indices to ignore and wildcard indices expressions.
UpdateSettingsRequestBuilder	setPreserveExisting(boolean preserveExisting)
UpdateSettingsRequestBuilder	setSettings(String source, XContentType xContentType)	Sets the settings to be updated (either json or yaml format)
UpdateSettingsRequestBuilder	setSettings(Map<String,Object> source)	Sets the settings to be updated
UpdateSettingsRequestBuilder	setSettings(Settings settings)	Sets the settings to be updated
UpdateSettingsRequestBuilder	setSettings(Settings.Builder settings)	Sets the settings to be updated

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequestBuilder

setTimeout, setTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateSettingsRequestBuilder

public UpdateSettingsRequestBuilder(ElasticsearchClient client,
 String... indices)

Method Details

setIndices

public UpdateSettingsRequestBuilder setIndices(String... indices)

Sets the indices the update settings will execute on

setIndicesOptions

public UpdateSettingsRequestBuilder setIndicesOptions(IndicesOptions options)

Specifies what type of requested indices to ignore and wildcard indices expressions.

For example indices that don't exist.

setSettings

public UpdateSettingsRequestBuilder setSettings(Settings settings)

Sets the settings to be updated

setSettings

public UpdateSettingsRequestBuilder setSettings(Settings.Builder settings)

Sets the settings to be updated

setSettings

public UpdateSettingsRequestBuilder setSettings(String source,
 XContentType xContentType)

Sets the settings to be updated (either json or yaml format)

setSettings

public UpdateSettingsRequestBuilder setSettings(Map<String,Object> source)

Sets the settings to be updated

setPreserveExisting

public UpdateSettingsRequestBuilder setPreserveExisting(boolean preserveExisting)

origin

public UpdateSettingsRequestBuilder origin(String origin)

Sets the origin to use, only set this when the settings update is requested by ES internal processes.