Package org.elasticsearch.client.indices

Class PutMappingRequest

java.lang.Object

org.elasticsearch.client.TimedRequest

org.elasticsearch.client.indices.PutMappingRequest

All Implemented Interfaces:

IndicesRequest, Validatable, ToXContent, ToXContentObject

public class PutMappingRequest
extends TimedRequest
implements IndicesRequest, ToXContentObject

Put a mapping definition into one or more indices. If an index already contains mappings, the new mappings will be merged with the existing one. If there are elements that cannot be merged, the request will be rejected.

Nested Class Summary

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

IndicesRequest.Replaceable

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.client.TimedRequest

DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String[]	indices()	The indices into which the mappings will be put.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
PutMappingRequest	indicesOptions(IndicesOptions indicesOptions)
BytesReference	source()	The mapping source definition.
PutMappingRequest	source(String mappingSource, XContentType xContentType)	The mapping source definition.
PutMappingRequest	source(Map<String,?> mappingSource)	The mapping source definition.
PutMappingRequest	source(BytesReference source, XContentType xContentType)	The mapping source definition.
PutMappingRequest	source(XContentBuilder builder)	The mapping source definition.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentType	xContentType()	The XContentType of the mapping source.

Methods inherited from class org.elasticsearch.client.TimedRequest

masterNodeTimeout, setMasterTimeout, setTimeout, timeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Constructor Detail

PutMappingRequest

public PutMappingRequest(String... indices)

Constructs a new put mapping request against one or more indices. If no indices are provided then it will be executed against all indices.

Method Detail

indices

public String[] indices()

The indices into which 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)

source

public BytesReference source()

The mapping source definition.

xContentType

public XContentType xContentType()

The XContentType of the mapping source.

source

public PutMappingRequest source(Map<String,?> mappingSource)

The mapping source definition. Note that the definition should *not* be nested under a type name.

source

public PutMappingRequest source(String mappingSource,
                                XContentType xContentType)

The mapping source definition. Note that the definition should *not* be nested under a type name.

source

public PutMappingRequest source(XContentBuilder builder)

The mapping source definition. Note that the definition should *not* be nested under a type name.

source

public PutMappingRequest source(BytesReference source,
                                XContentType xContentType)

The mapping source definition. Note that the definition should *not* be nested under a type name.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException