Package 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, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

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

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

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final IndicesOptions	DEFAULT_INDICES_OPTIONS

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 interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
UpdateSettingsRequest	fromXContent(XContentParser parser)
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
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)
boolean	isPreserveExisting()	Returns true iff the settings update should only add but not update settings.
String	origin()
UpdateSettingsRequest	origin(String origin)
UpdateSettingsRequest	setPreserveExisting(boolean preserveExisting)	Iff set to true this settings update will only add settings not already set on an index.
Settings	settings()
UpdateSettingsRequest	settings(String source, XContentType xContentType)	Sets the settings to be updated (either json or yaml format)
UpdateSettingsRequest	settings(Map<String,?> source)	Sets the settings to be updated (either json or yaml format)
UpdateSettingsRequest	settings(Settings settings)	Sets the settings to be updated
UpdateSettingsRequest	settings(Settings.Builder settings)	Sets the settings to be updated
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

ackTimeout, timeout, timeout, timeout

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

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

masterNodeTimeout

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

UpdateSettingsRequest

public UpdateSettingsRequest(StreamInput in)
                      throws IOException

Throws:

IOException

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 Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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

settings

public Settings settings()

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)

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

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,
 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(Map<String,?> source)

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

origin

public String origin()

origin

public UpdateSettingsRequest origin(String origin)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<UpdateSettingsRequest>

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public UpdateSettingsRequest fromXContent(XContentParser parser)
                                   throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class TransportRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object