Module org.elasticsearch.server
Class UpdateSettingsRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<UpdateSettingsRequest>
org.elasticsearch.action.support.master.AcknowledgedRequest<UpdateSettingsRequest>
org.elasticsearch.action.admin.indices.settings.put.UpdateSettingsRequest
- All Implemented Interfaces:
IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest,TransportRequest,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.action.support.master.AcknowledgedRequest
AcknowledgedRequest.PlainNested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest
DEFAULT_ACK_TIMEOUTFields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCEDFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionUpdateSettingsRequest(String... indices) Constructs a new request to update settings for one or more indicesUpdateSettingsRequest(Settings settings, String... indices) Constructs a new request to update settings for one or more indices -
Method Summary
Modifier and TypeMethodDescriptionbooleanfromXContent(XContentParser parser) inthashCode()booleanDetermines whether the request should be applied to data streams.String[]indices()Returns the array of indices that the action relates toSets the indices to apply to settings update toReturns the indices options used to resolve indices.indicesOptions(IndicesOptions indicesOptions) booleanReturnstrueiff the settings update should only add but not update settings.origin()booleanreopen()Returnstrueif non-dynamic setting updates should go through, by automatically unassigning shards in the same cluster state change as the setting update.voidreopen(boolean reopen) setPreserveExisting(boolean preserveExisting) Iff set totruethis settings update will only add settings not already set on an index.settings()settings(String source, XContentType xContentType) Sets the settings to be updated (either json or yaml format)Sets the settings to be updated (either json or yaml format)Sets the settings to be updatedsettings(Settings.Builder settings) Sets the settings to be updatedtoString()toXContent(XContentBuilder builder, ToXContent.Params params) validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest
ackTimeout, ackTimeoutMethods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestIdMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, createTask, getDescription, setParentTaskMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
UpdateSettingsRequest
- Throws:
IOException
-
UpdateSettingsRequest
public UpdateSettingsRequest() -
UpdateSettingsRequest
Constructs a new request to update settings for one or more indices -
UpdateSettingsRequest
Constructs a new request to update settings for one or more indices
-
-
Method Details
-
validate
- Overrides:
validatein classAcknowledgedRequest<UpdateSettingsRequest>
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
settings
-
indices
Sets the indices to apply to settings update to- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
indicesOptions
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
indicesOptions
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines whether the request should be applied to data streams. Whenfalse, none of the names or wildcard expressions inIndicesRequest.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:
includeDataStreamsin interfaceIndicesRequest
-
settings
Sets the settings to be updated -
settings
Sets the settings to be updated -
settings
Sets the settings to be updated (either json or yaml format) -
isPreserveExisting
public boolean isPreserveExisting()Returnstrueiff 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 isfalse -
setPreserveExisting
Iff set totruethis settings update will only add settings not already set on an index. Existing settings remain unchanged. -
settings
Sets the settings to be updated (either json or yaml format) -
origin
-
origin
-
reopen
public boolean reopen()Returnstrueif non-dynamic setting updates should go through, by automatically unassigning shards in the same cluster state change as the setting update. The shards will be automatically reassigned after the cluster state update is made. The default isfalse. -
reopen
public void reopen(boolean reopen) -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classAcknowledgedRequest<UpdateSettingsRequest>- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
toString
- Overrides:
toStringin classAbstractTransportRequest
-
equals
-
hashCode
public int hashCode()
-