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

Class UpdateSettingsRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

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

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

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

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, AckedRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices() Returns the array of indices that the action relates to
UpdateSettingsRequest	indices(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)
void	readFrom(StreamInput in)
UpdateSettingsRequest	settings(Map source) Sets the settings to be updated (either json/yaml/properties format)
UpdateSettingsRequest	settings(Settings.Builder settings) Sets the settings to be updated
UpdateSettingsRequest	settings(Settings settings) Sets the settings to be updated
UpdateSettingsRequest	settings(String source) Sets the settings to be updated (either json/yaml/properties format)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

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

Constructor Detail

UpdateSettingsRequest

public UpdateSettingsRequest()

UpdateSettingsRequest

public UpdateSettingsRequest(String... indices)

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

UpdateSettingsRequest

public UpdateSettingsRequest(Settings settings,
                     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<UpdateSettingsRequest>

indices

public 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(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

public UpdateSettingsRequest settings(String source)

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

settings

public UpdateSettingsRequest settings(Map source)

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<UpdateSettingsRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<UpdateSettingsRequest>

Throws:

IOException