Class PutMappingRequest
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<PutMappingRequest>
org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequest
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,AckedRequest
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,TaskAwareRequest
public class PutMappingRequest extends AcknowledgedRequest<PutMappingRequest> implements IndicesRequest.Replaceable, org.elasticsearch.common.xcontent.ToXContentObject
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.
-
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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
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.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description PutMappingRequest()
PutMappingRequest(java.lang.String... indices)
Constructs a new put mapping request against one or more indices.PutMappingRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description static org.elasticsearch.common.xcontent.XContentBuilder
buildFromSimplifiedDef(java.lang.String type, java.lang.Object... source)
Index
getConcreteIndex()
Returns a concrete index for this mapping ornull
if no concrete index is definedjava.lang.String[]
indices()
The indices the mappings will be put.PutMappingRequest
indices(java.lang.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)
java.lang.String
origin()
PutMappingRequest
origin(java.lang.String origin)
PutMappingRequest
setConcreteIndex(Index index)
Sets a concrete index for this put mapping request.java.lang.String
source()
The mapping source definition.PutMappingRequest
source(java.lang.Object... source)
A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").PutMappingRequest
source(java.lang.String mappingSource, org.elasticsearch.common.xcontent.XContentType xContentType)
The mapping source definition.PutMappingRequest
source(java.util.Map<java.lang.String,?> mappingSource)
The mapping source definition.PutMappingRequest
source(BytesReference mappingSource, org.elasticsearch.common.xcontent.XContentType xContentType)
The mapping source definition.PutMappingRequest
source(org.elasticsearch.common.xcontent.XContentBuilder mappingBuilder)
The mapping source definition.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
java.lang.String
type()
The mapping type.PutMappingRequest
type(java.lang.String type)
The type of the mappings.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.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
PutMappingRequest
- Throws:
java.io.IOException
-
PutMappingRequest
public PutMappingRequest() -
PutMappingRequest
public PutMappingRequest(java.lang.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 Details
-
validate
- Specified by:
validate
in classActionRequest
-
indices
Sets the indices this put mapping operation will execute on.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
setConcreteIndex
Sets a concrete index for this put mapping request. -
getConcreteIndex
Returns a concrete index for this mapping ornull
if no concrete index is defined -
indices
public java.lang.String[] indices()The indices the mappings will be put.- Specified by:
indices
in interfaceIndicesRequest
-
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 interfaceIndicesRequest
-
indicesOptions
-
type
public java.lang.String type()The mapping type. -
type
The type of the mappings. -
source
public java.lang.String source()The mapping source definition. -
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. -
origin
public java.lang.String origin() -
origin
-
buildFromSimplifiedDef
public static org.elasticsearch.common.xcontent.XContentBuilder buildFromSimplifiedDef(java.lang.String type, java.lang.Object... source)- Parameters:
type
- the mapping typesource
- consisting of field/properties pairs (e.g. "field1", "type=string,store=true")- Returns:
- the mappings definition
- Throws:
java.lang.IllegalArgumentException
- if the number of the source arguments is not divisible by two
-
source
The mapping source definition. -
source
The mapping source definition. -
source
public PutMappingRequest source(java.lang.String mappingSource, org.elasticsearch.common.xcontent.XContentType xContentType)The mapping source definition. -
source
public PutMappingRequest source(BytesReference mappingSource, org.elasticsearch.common.xcontent.XContentType xContentType)The mapping source definition. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classAcknowledgedRequest<PutMappingRequest>
- Throws:
java.io.IOException
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-