Package org.elasticsearch.client.indices
Class PutMappingRequest
java.lang.Object
org.elasticsearch.client.TimedRequest
org.elasticsearch.client.indices.PutMappingRequest
- All Implemented Interfaces:
IndicesRequest
,Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class PutMappingRequest
extends TimedRequest
implements IndicesRequest, org.elasticsearch.xcontent.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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionPutMappingRequest
(String... indices) Constructs a new put mapping request against one or more indices. -
Method Summary
Modifier and TypeMethodDescriptionString[]
indices()
The indices into which the mappings will be put.indicesOptions
(IndicesOptions indicesOptions) source()
The mapping source definition.The mapping source definition.The mapping source definition.source
(BytesReference bytesReference, org.elasticsearch.xcontent.XContentType type) The mapping source definition.source
(org.elasticsearch.xcontent.XContentBuilder builder) The mapping source definition.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) org.elasticsearch.xcontent.XContentType
TheXContentType
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.action.IndicesRequest
includeDataStreams
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
PutMappingRequest
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 Details
-
indices
The indices into which the mappings will be put.- Specified by:
indices
in interfaceIndicesRequest
-
indicesOptions
- Specified by:
indicesOptions
in interfaceIndicesRequest
-
indicesOptions
-
source
The mapping source definition. -
xContentType
public org.elasticsearch.xcontent.XContentType xContentType()TheXContentType
of the mapping source. -
source
The mapping source definition. Note that the definition should *not* be nested under a type name. -
source
The mapping source definition. Note that the definition should *not* be nested under a type name. -
source
The mapping source definition. Note that the definition should *not* be nested under a type name. -
source
public PutMappingRequest source(BytesReference bytesReference, org.elasticsearch.xcontent.XContentType type) The mapping source definition. Note that the definition should *not* be nested under a type name. -
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-