org.elasticsearch.action.admin.indices.mapping.put

Class PutMappingRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

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

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

org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequest

All Implemented Interfaces:

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

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

Puts mapping definition registered under a specific type into one or more indices. Best created with Requests.putMappingRequest(String...).

If the mappings already exists, the new mappings will be merged with the new one. If there are elements that can't be merged are detected, the request will be rejected unless the ignoreConflicts(boolean) is set. In such a case, the duplicate mappings will be rejected.

See Also:

Requests.putMappingRequest(String...), IndicesAdminClient.putMapping(PutMappingRequest), PutMappingResponse

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.MasterNodeOperationRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
PutMappingRequest(String... indices) Constructs a new put mapping request against one or more indices.

Method Summary

Modifier and Type	Method and Description
static XContentBuilder	buildFromSimplifiedDef(String type, Object... source)
boolean	ignoreConflicts() If there is already a mapping definition registered against the type, then it will be merged.
PutMappingRequest	ignoreConflicts(boolean ignoreDuplicates) If there is already a mapping definition registered against the type, then it will be merged.
String[]	indices() The indices the mappings will be put.
PutMappingRequest	indices(String[] indices) Sets the indices this put mapping operation will execute on.
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
PutMappingRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
String	source() The mapping source definition.
PutMappingRequest	source(Map mappingSource) The mapping source definition.
PutMappingRequest	source(Object... source) A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
PutMappingRequest	source(String mappingSource) The mapping source definition.
PutMappingRequest	source(XContentBuilder mappingBuilder) The mapping source definition.
String	type() The mapping type.
PutMappingRequest	type(String type) The type of the mappings.
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.MasterNodeOperationRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, 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

PutMappingRequest

public PutMappingRequest(String... indices)

Constructs a new put mapping request against one or more indices. If nothing is set then it will be executed against all indices.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<PutMappingRequest>

indices

public PutMappingRequest indices(String[] indices)

Sets the indices this put mapping operation will execute on.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

The indices the mappings will be put.

Specified by:

indices in interface IndicesRequest

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 PutMappingRequest indicesOptions(IndicesOptions indicesOptions)

type

public String type()

The mapping type.

type

public PutMappingRequest type(String type)

The type of the mappings.

source

public String source()

The mapping source definition.

source

public PutMappingRequest source(Object... source)

A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true"). Also supports metadata mapping fields such as `_all` and `_parent` as property definition, these metadata mapping fields will automatically be put on the top level mapping object.

buildFromSimplifiedDef

public static XContentBuilder buildFromSimplifiedDef(String type,
                                                     Object... source)

source

public PutMappingRequest source(XContentBuilder mappingBuilder)

The mapping source definition.

source

public PutMappingRequest source(Map mappingSource)

The mapping source definition.

source

public PutMappingRequest source(String mappingSource)

The mapping source definition.

ignoreConflicts

public boolean ignoreConflicts()

If there is already a mapping definition registered against the type, then it will be merged. If there are elements that can't be merged are detected, the request will be rejected unless the ignoreConflicts(boolean) is set. In such a case, the duplicate mappings will be rejected.

ignoreConflicts

public PutMappingRequest ignoreConflicts(boolean ignoreDuplicates)

If there is already a mapping definition registered against the type, then it will be merged. If there are elements that can't be merged are detected, the request will be rejected unless the ignoreConflicts(boolean) is set. In such a case, the duplicate mappings will be rejected.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeOperationRequest<PutMappingRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeOperationRequest<PutMappingRequest>

Throws:

IOException