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

Class UpdateSettingsClusterStateUpdateRequest

java.lang.Object

org.elasticsearch.cluster.ack.ClusterStateUpdateRequest<T>

org.elasticsearch.cluster.ack.IndicesClusterStateUpdateRequest<UpdateSettingsClusterStateUpdateRequest>

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

All Implemented Interfaces:

AckedRequest

public class UpdateSettingsClusterStateUpdateRequest
extends IndicesClusterStateUpdateRequest<UpdateSettingsClusterStateUpdateRequest>

Cluster state update request that allows to update settings for some indices

Constructor Summary

Constructors

Constructor	Description
UpdateSettingsClusterStateUpdateRequest()

Method Summary

Modifier and Type	Method	Description
boolean	isPreserveExisting()	Returns true iff the settings update should only add but not update settings.
UpdateSettingsClusterStateUpdateRequest	setPreserveExisting(boolean preserveExisting)	Iff set to true this settings update will only add settings not already set on an index.
Settings	settings()	Returns the Settings to update
UpdateSettingsClusterStateUpdateRequest	settings(Settings settings)	Sets the Settings to update

Methods inherited from class org.elasticsearch.cluster.ack.IndicesClusterStateUpdateRequest

indices, indices

Methods inherited from class org.elasticsearch.cluster.ack.ClusterStateUpdateRequest

ackTimeout, ackTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateSettingsClusterStateUpdateRequest

public UpdateSettingsClusterStateUpdateRequest()

Method Details

isPreserveExisting

public boolean isPreserveExisting()

Returns true iff the settings update should only add but not update settings. If the setting already exists it should not be overwritten by this update. The default is false

setPreserveExisting

public UpdateSettingsClusterStateUpdateRequest setPreserveExisting(boolean preserveExisting)

Iff set to true this settings update will only add settings not already set on an index. Existing settings remain unchanged.

settings

public Settings settings()

Returns the Settings to update

settings

public UpdateSettingsClusterStateUpdateRequest settings(Settings settings)

Sets the Settings to update