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

Class UpdateSettingsRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<UpdateSettingsRequest>

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, Streamable, TaskAwareRequest

public class UpdateSettingsRequest
extends AcknowledgedRequest<UpdateSettingsRequest>
implements IndicesRequest.Replaceable

Request for an update index settings action

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor and Description
UpdateSettingsRequest()
UpdateSettingsRequest(Settings settings, java.lang.String... indices) Constructs a new request to update settings for one or more indices
UpdateSettingsRequest(java.lang.String... indices) Constructs a new request to update settings for one or more indices

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	indices() Returns the array of indices that the action relates to
UpdateSettingsRequest	indices(java.lang.String... indices) Sets the indices to apply to settings update to
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
UpdateSettingsRequest	indicesOptions(IndicesOptions indicesOptions)
boolean	isPreserveExisting() Returns true iff the settings update should only add but not update settings.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
UpdateSettingsRequest	setPreserveExisting(boolean preserveExisting) Iff set to true this settings update will only add settings not already set on an index.
UpdateSettingsRequest	settings(java.util.Map source) Sets the settings to be updated (either json or yaml format)
UpdateSettingsRequest	settings(Settings.Builder settings) Sets the settings to be updated
UpdateSettingsRequest	settings(Settings settings) Sets the settings to be updated
UpdateSettingsRequest	settings(java.lang.String source) Deprecated. use settings(String, XContentType) to avoid content type detection
UpdateSettingsRequest	settings(java.lang.String source, XContentType xContentType) Sets the settings to be updated (either json or yaml format)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

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

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Detail

UpdateSettingsRequest

public UpdateSettingsRequest()

UpdateSettingsRequest

public UpdateSettingsRequest(java.lang.String... indices)

Constructs a new request to update settings for one or more indices

UpdateSettingsRequest

public UpdateSettingsRequest(Settings settings,
                             java.lang.String... indices)

Constructs a new request to update settings for one or more indices

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indices

public UpdateSettingsRequest indices(java.lang.String... indices)

Sets the indices to apply to settings update to

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public UpdateSettingsRequest indicesOptions(IndicesOptions indicesOptions)

settings

public UpdateSettingsRequest settings(Settings settings)

Sets the settings to be updated

settings

public UpdateSettingsRequest settings(Settings.Builder settings)

Sets the settings to be updated

settings

@Deprecated
public UpdateSettingsRequest settings(java.lang.String source)

Deprecated. use settings(String, XContentType) to avoid content type detection

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

settings

public UpdateSettingsRequest settings(java.lang.String source,
                                      XContentType xContentType)

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

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 UpdateSettingsRequest 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 UpdateSettingsRequest settings(java.util.Map source)

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

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AcknowledgedRequest<UpdateSettingsRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class AcknowledgedRequest<UpdateSettingsRequest>

Throws:

java.io.IOException